Okta API (2.7.0)

Download OpenAPI specification:Download

Okta Developer Team: devex-public@okta.com URL: https://developer.okta.com/ License: Apache-2.0 Terms of Service

Allows customers to easily access the Okta API

Authentication

api_token

Pass the API token as the Authorization header value prefixed with SSWS: 'Authorizaion: SSWS {API Token}'

Security Scheme Type	API Key
Header parameter name:	Authorization

oauth2

Pass the access_token as the value of the Authorization header: 'Authorization: {access_token}'

Security Scheme Type	OAuth2
authorizationCode OAuth Flow	Authorization URL: /oauth2/v1/authorize Token URL: /oauth2/v1/token Scopes: `okta.captchas.manage` - Read or modify catpcha instances in your org. `okta.captchas.read` - Read catpcha instances in your org.

Application

List Applications

Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query.

Authorizations:

api_token

query Parameters

after	string Specifies the pagination cursor for the next page of apps
expand	string Traverses users link relationship and optionally embeds Application User resource
filter	string Filters apps by status, user.id, group.id or credentials.signing.kid expression
includeNonDeleted	boolean Default: false
limit	integer <int32> Default: -1 Specifies the number of results for a page
q	string

Responses

Response Schema: application/json

Array ()

	object (SchemeApplicationCredentials)
	object (AutoLoginApplicationSettings)

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"accessibility": {"errorRedirectUrl": "string",
"loginRedirectUrl": "string",
"selfService": true
},
"created": "2019-08-24T14:15:22Z",
"credentials": {"signing": {"kid": "string",
"lastRotated": "2019-08-24T14:15:22Z",
"nextRotation": "2019-08-24T14:15:22Z",
"rotationMode": "string",
"use": "sig"
},
"userNameTemplate": {"suffix": "string",
"template": "string",
"type": "string"
}
},
"features": ["string"
],
"id": "string",
"label": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"licensing": {"seatCount": 0
},
"name": "string",
"profile": {"property1": { },
"property2": { }
},
"settings": {"app": { },
"implicitAssignment": true,
"inlineHookId": "string",
"notifications": {"vpn": {"helpUrl": "string",
"message": "string",
"network": {"connection": "string",
"exclude": ["string"
],
"include": ["string"
]
}
}
},
"notes": {"admin": "string",
"enduser": "string"
}
},
"signOnMode": "BOOKMARK",
"status": "ACTIVE",
"visibility": {"appLinks": {"property1": true,
"property2": true
},
"autoLaunch": true,
"autoSubmitToolbar": true,
"hide": {"iOS": true,
"web": true
}
}
}
]

Add Application

Adds a new application to your Okta organization.

Authorizations:

api_token

query Parameters

activate

boolean

Default: true

Executes activation lifecycle operation when creating the app

header Parameters

OktaAccessGateway-Agent

string

Request Body schema: application/json

	object (SchemeApplicationCredentials)
	object (AutoLoginApplicationSettings)

Responses

Response Schema: application/json

	object (SchemeApplicationCredentials)
	object (AutoLoginApplicationSettings)

Request samples

Content type

application/json

Example

{"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"revealPassword": true,
"scheme": "SHARED_USERNAME_AND_PASSWORD",
"signing": {"kid": "string",
"rotationMode": "string",
"use": "sig"
},
"userName": "string"
},
"settings": {"signOn": {"loginUrl": "string",
"redirectUrl": "string"
}
},
"signOnMode": "AUTO_LOGIN"
}

Response samples

200

Content type

application/json

Example

{"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"revealPassword": true,
"scheme": "SHARED_USERNAME_AND_PASSWORD",
"signing": {"kid": "string",
"lastRotated": "2019-08-24T14:15:22Z",
"nextRotation": "2019-08-24T14:15:22Z",
"rotationMode": "string",
"use": "sig"
},
"userName": "string"
},
"settings": {"signOn": {"loginUrl": "string",
"redirectUrl": "string"
}
},
"signOnMode": "AUTO_LOGIN"
}

Get Application

Fetches an application from your Okta organization by id.

Authorizations:

api_token

path Parameters

appId

required

string

query Parameters

expand

string

Responses

Response Schema: application/json

	object (SchemeApplicationCredentials)
	object (AutoLoginApplicationSettings)

Response samples

200

Content type

application/json

Example

{"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"revealPassword": true,
"scheme": "SHARED_USERNAME_AND_PASSWORD",
"signing": {"kid": "string",
"lastRotated": "2019-08-24T14:15:22Z",
"nextRotation": "2019-08-24T14:15:22Z",
"rotationMode": "string",
"use": "sig"
},
"userName": "string"
},
"settings": {"signOn": {"loginUrl": "string",
"redirectUrl": "string"
}
},
"signOnMode": "AUTO_LOGIN"
}

Update Application

Updates an application in your organization.

Authorizations:

api_token

path Parameters

appId

required

string

Request Body schema: application/json

	object (SchemeApplicationCredentials)
	object (AutoLoginApplicationSettings)

Responses

Response Schema: application/json

	object (SchemeApplicationCredentials)
	object (AutoLoginApplicationSettings)

Request samples

Content type

application/json

Example

{"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"revealPassword": true,
"scheme": "SHARED_USERNAME_AND_PASSWORD",
"signing": {"kid": "string",
"rotationMode": "string",
"use": "sig"
},
"userName": "string"
},
"settings": {"signOn": {"loginUrl": "string",
"redirectUrl": "string"
}
},
"signOnMode": "AUTO_LOGIN"
}

Response samples

200

Content type

application/json

Example

{"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"revealPassword": true,
"scheme": "SHARED_USERNAME_AND_PASSWORD",
"signing": {"kid": "string",
"lastRotated": "2019-08-24T14:15:22Z",
"nextRotation": "2019-08-24T14:15:22Z",
"rotationMode": "string",
"use": "sig"
},
"userName": "string"
},
"settings": {"signOn": {"loginUrl": "string",
"redirectUrl": "string"
}
},
"signOnMode": "AUTO_LOGIN"
}

Delete Application

Removes an inactive application.

Authorizations:

api_token

path Parameters

appId

required

string

Responses

List Certificate Signing Requests for Application

Enumerates Certificate Signing Requests for an application

Authorizations:

api_token

path Parameters

appId

required

string

Responses

Response Schema: application/json

Array ()

created	string <date-time>
csr	string
id	string
kty	string

Response samples

200

Content type

application/json

[{"created": "2019-08-24T14:15:22Z",
"csr": "string",
"id": "string",
"kty": "string"
}
]

Generate Certificate Signing Request for Application

Generates a new key pair and returns the Certificate Signing Request for it.

Authorizations:

api_token

path Parameters

appId

required

string

Request Body schema: application/json

	object (CsrMetadataSubject)
	object (CsrMetadataSubjectAltNames)

Responses

Response Schema: application/json

created	string <date-time>
csr	string
id	string
kty	string

Request samples

Content type

application/json

{"subject": {"commonName": "string",
"countryName": "string",
"localityName": "string",
"organizationName": "string",
"organizationalUnitName": "string",
"stateOrProvinceName": "string"
},
"subjectAltNames": {"dnsNames": ["string"
]
}
}

Response samples

201

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"csr": "string",
"id": "string",
"kty": "string"
}

Get Certificate Signing Request

Fetches a certificate signing request for the app by id.

Authorizations:

api_token

path Parameters

appId required	string
csrId required	string

Responses

Response Schema: application/json

created	string <date-time>
csr	string
id	string
kty	string

Response samples

200

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"csr": "string",
"id": "string",
"kty": "string"
}

Revoke Certificate Signing Request

Revokes a certificate signing request and deletes the key pair from the application.

Authorizations:

api_token

path Parameters

appId required	string
csrId required	string

Responses

Publish Certificate Signing Request

Updates a certificate signing request for the app with a signed X.509 certificate and adds it into the application key credentials

Authorizations:

api_token

path Parameters

appId required	string
csrId required	string

Request Body schema:
application/octet-stream
application/octet-stream
application/x-x509-ca-cert
application/pkix-cert
application/x-pem-file

string <binary>

Responses

Response Schema: application/json

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Response samples

201

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}

List Key Credentials for Application

Enumerates key credentials for an application

Authorizations:

api_token

path Parameters

appId

required

string

Responses

Response Schema: application/json

Array ()

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}
]

generateApplicationKey

Generates a new X.509 certificate for an application key credential

Authorizations:

api_token

path Parameters

appId

required

string

query Parameters

validityYears

integer

Responses

Response Schema: application/json

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Response samples

201

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}

Get Key Credential for Application

Gets a specific application key credential by kid

Authorizations:

api_token

path Parameters

appId required	string
keyId required	string

Responses

Response Schema: application/json

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}

Clone Application Key Credential

Clones a X.509 certificate for an application key credential from a source application to target application.

Authorizations:

api_token

path Parameters

appId required	string
keyId required	string

query Parameters

targetAid

required

string

Unique key of the target Application

Responses

Response Schema: application/json

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Response samples

201

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}

listScopeConsentGrants

Lists all scope consent grants for the application

Authorizations:

api_token

path Parameters

appId

required

string

query Parameters

expand

string

Responses

Response Schema: application/json

Array ()

	object
	object
clientId	string
created	string <date-time>
	object (OAuth2Actor)
id	string
issuer	string
lastUpdated	string <date-time>
scopeId	string
source	string (OAuth2ScopeConsentGrantSource) Enum: "END_USER" "ADMIN"
status	string (OAuth2ScopeConsentGrantStatus) Enum: "ACTIVE" "REVOKED"
userId	string

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"clientId": "string",
"userId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": {"id": "string",
"type": "string"
},
"id": "string",
"issuer": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"scopeId": "string",
"source": "END_USER",
"status": "ACTIVE"
}
]

grantConsentToScope

Grants consent for the application to request an OAuth 2.0 Okta scope

Authorizations:

api_token

path Parameters

appId

required

string

Request Body schema: application/json

clientId	string
	object (OAuth2Actor)
issuer	string
scopeId	string
source	string (OAuth2ScopeConsentGrantSource) Enum: "END_USER" "ADMIN"
status	string (OAuth2ScopeConsentGrantStatus) Enum: "ACTIVE" "REVOKED"
userId	string

Responses

Response Schema: application/json

	object
	object
clientId	string
created	string <date-time>
	object (OAuth2Actor)
id	string
issuer	string
lastUpdated	string <date-time>
scopeId	string
source	string (OAuth2ScopeConsentGrantSource) Enum: "END_USER" "ADMIN"
status	string (OAuth2ScopeConsentGrantStatus) Enum: "ACTIVE" "REVOKED"
userId	string

Request samples

Content type

application/json

{"clientId": "string",
"userId": "string",
"createdBy": {"type": "string"
},
"issuer": "string",
"scopeId": "string",
"source": "END_USER",
"status": "ACTIVE"
}

Response samples

201

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"clientId": "string",
"userId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": {"id": "string",
"type": "string"
},
"id": "string",
"issuer": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"scopeId": "string",
"source": "END_USER",
"status": "ACTIVE"
}

getScopeConsentGrant

Fetches a single scope consent grant for the application

Authorizations:

api_token

path Parameters

appId required	string
grantId required	string

query Parameters

expand

string

Responses

Response Schema: application/json

	object
	object
clientId	string
created	string <date-time>
	object (OAuth2Actor)
id	string
issuer	string
lastUpdated	string <date-time>
scopeId	string
source	string (OAuth2ScopeConsentGrantSource) Enum: "END_USER" "ADMIN"
status	string (OAuth2ScopeConsentGrantStatus) Enum: "ACTIVE" "REVOKED"
userId	string

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"clientId": "string",
"userId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": {"id": "string",
"type": "string"
},
"id": "string",
"issuer": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"scopeId": "string",
"source": "END_USER",
"status": "ACTIVE"
}

revokeScopeConsentGrant

Revokes permission for the application to request the given scope

Authorizations:

api_token

path Parameters

appId required	string
grantId required	string

Responses

List Groups Assigned to Application

Enumerates group assignments for an application.

Authorizations:

api_token

path Parameters

appId

required

string

query Parameters

after	string Specifies the pagination cursor for the next page of assignments
expand	string
limit	integer <int32> Default: -1 Specifies the number of results for a page
q	string

Responses

Response Schema: application/json

Array ()

	object
	object
id	string
lastUpdated	string <date-time>
priority	integer
	object

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"priority": 0,
"profile": {"property1": { },
"property2": { }
}
}
]

Get Assigned Group for Application

Fetches an application group assignment

Authorizations:

api_token

path Parameters

appId required	string
groupId required	string

query Parameters

expand

string

Responses

Response Schema: application/json

	object
	object
id	string
lastUpdated	string <date-time>
priority	integer
	object

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"priority": 0,
"profile": {"property1": { },
"property2": { }
}
}

Assign Group to Application

Assigns a group to an application

Authorizations:

api_token

path Parameters

appId required	string
groupId required	string

Request Body schema: application/json

priority	integer
	object

Responses

Response Schema: application/json

	object
	object
id	string
lastUpdated	string <date-time>
priority	integer
	object

Request samples

Content type

application/json

{"priority": 0,
"profile": {"property1": { },
"property2": { }
}
}

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"priority": 0,
"profile": {"property1": { },
"property2": { }
}
}

Remove Group from Application

Removes a group assignment from an application.

Authorizations:

api_token

path Parameters

appId required	string
groupId required	string

Responses

Activate Application

Activates an inactive application.

Authorizations:

api_token

path Parameters

appId

required

string

Responses

Deactivate Application

Deactivates an active application.

Authorizations:

api_token

path Parameters

appId

required

string

Responses

listOAuth2TokensForApplication

Lists all tokens for the application

Authorizations:

api_token

path Parameters

appId

required

string

query Parameters

after	string
expand	string
limit	integer <int32> Default: 20

Responses

Response Schema: application/json

Array ()

	object
	object
clientId	string
created	string <date-time>
expiresAt	string <date-time>
id	string
issuer	string
lastUpdated	string <date-time>
scopes	Array of strings
status	string Enum: "ACTIVE" "REVOKED"
userId	string

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"issuer": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"scopes": ["string"
],
"status": "ACTIVE",
"userId": "string"
}
]

revokeOAuth2TokensForApplication

Revokes all tokens for the specified application

Authorizations:

api_token

path Parameters

appId

required

string

Responses

getOAuth2TokenForApplication

Gets a token for the specified application

Authorizations:

api_token

path Parameters

appId required	string
tokenId required	string

query Parameters

expand

string

Responses

Response Schema: application/json

	object
	object
clientId	string
created	string <date-time>
expiresAt	string <date-time>
id	string
issuer	string
lastUpdated	string <date-time>
scopes	Array of strings
status	string Enum: "ACTIVE" "REVOKED"
userId	string

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"issuer": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"scopes": ["string"
],
"status": "ACTIVE",
"userId": "string"
}

revokeOAuth2TokenForApplication

Revokes the specified token for the specified application

Authorizations:

api_token

path Parameters

appId required	string
tokenId required	string

Responses

List Users Assigned to Application

Enumerates all assigned application users for an application.

Authorizations:

api_token

path Parameters

appId

required

string

query Parameters

after	string specifies the pagination cursor for the next page of assignments
expand	string
filter	string
limit	integer <int32> Default: -1 specifies the number of results for a page
q	string
query_scope	string

Responses

Response Schema: application/json

Array ()

	object
	object
created	string <date-time>
	object (AppUserCredentials)
externalId	string
id	string
lastSync	string <date-time>
lastUpdated	string <date-time>
passwordChanged	string <date-time>
	object
scope	string
status	string
statusChanged	string <date-time>
syncState	string

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"credentials": {"password": {"value": "pa$$word"
},
"userName": "string"
},
"externalId": "string",
"id": "string",
"lastSync": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"passwordChanged": "2019-08-24T14:15:22Z",
"profile": {"property1": { },
"property2": { }
},
"scope": "string",
"status": "string",
"statusChanged": "2019-08-24T14:15:22Z",
"syncState": "string"
}
]

Assign User to Application for SSO & Provisioning

Assigns an user to an application with credentials and an app-specific profile. Profile mappings defined for the application are first applied before applying any profile properties specified in the request.

Authorizations:

api_token

path Parameters

appId

required

string

Request Body schema: application/json

	object (AppUserCredentials)
id	string
	object
scope	string

Responses

Response Schema: application/json

	object
	object
created	string <date-time>
	object (AppUserCredentials)
externalId	string
id	string
lastSync	string <date-time>
lastUpdated	string <date-time>
passwordChanged	string <date-time>
	object
scope	string
status	string
statusChanged	string <date-time>
syncState	string

Request samples

Content type

application/json

{"credentials": {"password": {"value": "pa$$word"
},
"userName": "string"
},
"id": "string",
"profile": {"property1": { },
"property2": { }
},
"scope": "string"
}

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"credentials": {"password": {"value": "pa$$word"
},
"userName": "string"
},
"externalId": "string",
"id": "string",
"lastSync": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"passwordChanged": "2019-08-24T14:15:22Z",
"profile": {"property1": { },
"property2": { }
},
"scope": "string",
"status": "string",
"statusChanged": "2019-08-24T14:15:22Z",
"syncState": "string"
}

Get Assigned User for Application

Fetches a specific user assignment for application by id.

Authorizations:

api_token

path Parameters

appId required	string
userId required	string

query Parameters

expand

string

Responses

Response Schema: application/json

	object
	object
created	string <date-time>
	object (AppUserCredentials)
externalId	string
id	string
lastSync	string <date-time>
lastUpdated	string <date-time>
passwordChanged	string <date-time>
	object
scope	string
status	string
statusChanged	string <date-time>
syncState	string

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"credentials": {"password": {"value": "pa$$word"
},
"userName": "string"
},
"externalId": "string",
"id": "string",
"lastSync": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"passwordChanged": "2019-08-24T14:15:22Z",
"profile": {"property1": { },
"property2": { }
},
"scope": "string",
"status": "string",
"statusChanged": "2019-08-24T14:15:22Z",
"syncState": "string"
}

Update Application Profile for Assigned User

Updates a user's profile for an application

Authorizations:

api_token

path Parameters

appId required	string
userId required	string

Request Body schema: application/json

	object (AppUserCredentials)
id	string
	object
scope	string

Responses

Response Schema: application/json

	object
	object
created	string <date-time>
	object (AppUserCredentials)
externalId	string
id	string
lastSync	string <date-time>
lastUpdated	string <date-time>
passwordChanged	string <date-time>
	object
scope	string
status	string
statusChanged	string <date-time>
syncState	string

Request samples

Content type

application/json

{"credentials": {"password": {"value": "pa$$word"
},
"userName": "string"
},
"id": "string",
"profile": {"property1": { },
"property2": { }
},
"scope": "string"
}

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"credentials": {"password": {"value": "pa$$word"
},
"userName": "string"
},
"externalId": "string",
"id": "string",
"lastSync": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"passwordChanged": "2019-08-24T14:15:22Z",
"profile": {"property1": { },
"property2": { }
},
"scope": "string",
"status": "string",
"statusChanged": "2019-08-24T14:15:22Z",
"syncState": "string"
}

Remove User from Application

Removes an assignment for a user from an application.

Authorizations:

api_token

path Parameters

appId required	string
userId required	string

query Parameters

sendEmail

boolean

Default: false

Responses

Authenticator

List Authenticators

Enumerates authenticators in your organization.

Authorizations:

api_token

Responses

Response Schema: application/json

Array ()

	object
created	string <date-time>
id	string
key	string
lastUpdated	string <date-time>
name	string
	object (AuthenticatorSettings)
status	string (AuthenticatorStatus) Enum: "ACTIVE" "INACTIVE"
type	string (AuthenticatorType) Enum: "password" "security_question" "phone" "email" "security_key"

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"key": "string",
"status": "ACTIVE",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"type": "password",
"settings": {"allowedFor": "recovery",
"tokenLifetimeInMinutes": 0
}
}
]

Get Authenticator

Fetches an authenticator from your Okta organization by authenticatorId.

Authorizations:

api_token

path Parameters

authenticatorId

required

string

Responses

Response Schema: application/json

	object
created	string <date-time>
id	string
key	string
lastUpdated	string <date-time>
name	string
	object (AuthenticatorSettings)
status	string (AuthenticatorStatus) Enum: "ACTIVE" "INACTIVE"
type	string (AuthenticatorType) Enum: "password" "security_question" "phone" "email" "security_key"

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"key": "string",
"status": "ACTIVE",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"type": "password",
"settings": {"allowedFor": "recovery",
"tokenLifetimeInMinutes": 0
}
}

Activate Authenticator

Activates an authenticator by authenticatorId.

Authorizations:

api_token

path Parameters

authenticatorId

required

string

Responses

Deactivate Authenticator

Deactivates an authenticator by authenticatorId.

Authorizations:

api_token

path Parameters

authenticatorId

required

string

Responses

AuthorizationServer

listAuthorizationServers

Success

Authorizations:

api_token

query Parameters

after	string
limit	string
q	string

Responses

Response Schema: application/json

Array ()

	object
audiences	Array of strings
created	string <date-time>
	object (AuthorizationServerCredentials)
description	string
id	string
issuer	string
issuerMode	string Enum: "ORG_URL" "CUSTOM_URL"
lastUpdated	string <date-time>
name	string
status	string Enum: "ACTIVE" "INACTIVE"

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"audiences": ["string"
],
"created": "2019-08-24T14:15:22Z",
"credentials": {"signing": {"kid": "string",
"lastRotated": "2019-08-24T14:15:22Z",
"nextRotation": "2019-08-24T14:15:22Z",
"rotationMode": "AUTO",
"use": "sig"
}
},
"description": "string",
"id": "string",
"issuer": "string",
"issuerMode": "ORG_URL",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE"
}
]

createAuthorizationServer

Success

Authorizations:

api_token

Request Body schema: application/json

audiences	Array of strings
	object (AuthorizationServerCredentials)
description	string
issuer	string
issuerMode	string Enum: "ORG_URL" "CUSTOM_URL"
name	string
status	string Enum: "ACTIVE" "INACTIVE"

Responses

Response Schema: application/json

	object
audiences	Array of strings
created	string <date-time>
	object (AuthorizationServerCredentials)
description	string
id	string
issuer	string
issuerMode	string Enum: "ORG_URL" "CUSTOM_URL"
lastUpdated	string <date-time>
name	string
status	string Enum: "ACTIVE" "INACTIVE"

Request samples

Content type

application/json

{"audiences": ["string"
],
"credentials": {"signing": {"kid": "string",
"rotationMode": "AUTO",
"use": "sig"
}
},
"description": "string",
"issuer": "string",
"issuerMode": "ORG_URL",
"name": "string",
"status": "ACTIVE"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"audiences": ["string"
],
"created": "2019-08-24T14:15:22Z",
"credentials": {"signing": {"kid": "string",
"lastRotated": "2019-08-24T14:15:22Z",
"nextRotation": "2019-08-24T14:15:22Z",
"rotationMode": "AUTO",
"use": "sig"
}
},
"description": "string",
"id": "string",
"issuer": "string",
"issuerMode": "ORG_URL",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE"
}

getAuthorizationServer

Success

Authorizations:

api_token

path Parameters

authServerId

required

string

Responses

Response Schema: application/json

	object
audiences	Array of strings
created	string <date-time>
	object (AuthorizationServerCredentials)
description	string
id	string
issuer	string
issuerMode	string Enum: "ORG_URL" "CUSTOM_URL"
lastUpdated	string <date-time>
name	string
status	string Enum: "ACTIVE" "INACTIVE"

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"audiences": ["string"
],
"created": "2019-08-24T14:15:22Z",
"credentials": {"signing": {"kid": "string",
"lastRotated": "2019-08-24T14:15:22Z",
"nextRotation": "2019-08-24T14:15:22Z",
"rotationMode": "AUTO",
"use": "sig"
}
},
"description": "string",
"id": "string",
"issuer": "string",
"issuerMode": "ORG_URL",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE"
}

updateAuthorizationServer

Success

Authorizations:

api_token

path Parameters

authServerId

required

string

Request Body schema: application/json

audiences	Array of strings
	object (AuthorizationServerCredentials)
description	string
issuer	string
issuerMode	string Enum: "ORG_URL" "CUSTOM_URL"
name	string
status	string Enum: "ACTIVE" "INACTIVE"

Responses

Response Schema: application/json

	object
audiences	Array of strings
created	string <date-time>
	object (AuthorizationServerCredentials)
description	string
id	string
issuer	string
issuerMode	string Enum: "ORG_URL" "CUSTOM_URL"
lastUpdated	string <date-time>
name	string
status	string Enum: "ACTIVE" "INACTIVE"

Request samples

Content type

application/json

{"audiences": ["string"
],
"credentials": {"signing": {"kid": "string",
"rotationMode": "AUTO",
"use": "sig"
}
},
"description": "string",
"issuer": "string",
"issuerMode": "ORG_URL",
"name": "string",
"status": "ACTIVE"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"audiences": ["string"
],
"created": "2019-08-24T14:15:22Z",
"credentials": {"signing": {"kid": "string",
"lastRotated": "2019-08-24T14:15:22Z",
"nextRotation": "2019-08-24T14:15:22Z",
"rotationMode": "AUTO",
"use": "sig"
}
},
"description": "string",
"id": "string",
"issuer": "string",
"issuerMode": "ORG_URL",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE"
}

deleteAuthorizationServer

Success

Authorizations:

api_token

path Parameters

authServerId

required

string

Responses

listOAuth2Claims

Success

Authorizations:

api_token

path Parameters

authServerId

required

string

Responses

Response Schema: application/json

Array ()

	object
alwaysIncludeInToken	boolean
claimType	string Enum: "IDENTITY" "RESOURCE"
	object (OAuth2ClaimConditions)
group_filter_type	string Enum: "STARTS_WITH" "EQUALS" "CONTAINS" "REGEX"
id	string
name	string
status	string Enum: "ACTIVE" "INACTIVE"
system	boolean
value	string
valueType	string Enum: "EXPRESSION" "GROUPS" "SYSTEM"

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"alwaysIncludeInToken": true,
"claimType": "IDENTITY",
"conditions": {"scopes": ["string"
]
},
"group_filter_type": "STARTS_WITH",
"id": "string",
"name": "string",
"status": "ACTIVE",
"system": true,
"value": "string",
"valueType": "EXPRESSION"
}
]

createOAuth2Claim

Success

Authorizations:

api_token

path Parameters

authServerId

required

string

Request Body schema: application/json

alwaysIncludeInToken	boolean
claimType	string Enum: "IDENTITY" "RESOURCE"
	object (OAuth2ClaimConditions)
group_filter_type	string Enum: "STARTS_WITH" "EQUALS" "CONTAINS" "REGEX"
name	string
status	string Enum: "ACTIVE" "INACTIVE"
system	boolean
value	string
valueType	string Enum: "EXPRESSION" "GROUPS" "SYSTEM"

Responses

Response Schema: application/json

	object
alwaysIncludeInToken	boolean
claimType	string Enum: "IDENTITY" "RESOURCE"
	object (OAuth2ClaimConditions)
group_filter_type	string Enum: "STARTS_WITH" "EQUALS" "CONTAINS" "REGEX"
id	string
name	string
status	string Enum: "ACTIVE" "INACTIVE"
system	boolean
value	string
valueType	string Enum: "EXPRESSION" "GROUPS" "SYSTEM"

Request samples

Content type

application/json

{"alwaysIncludeInToken": true,
"claimType": "IDENTITY",
"conditions": {"scopes": ["string"
]
},
"group_filter_type": "STARTS_WITH",
"name": "string",
"status": "ACTIVE",
"system": true,
"value": "string",
"valueType": "EXPRESSION"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"alwaysIncludeInToken": true,
"claimType": "IDENTITY",
"conditions": {"scopes": ["string"
]
},
"group_filter_type": "STARTS_WITH",
"id": "string",
"name": "string",
"status": "ACTIVE",
"system": true,
"value": "string",
"valueType": "EXPRESSION"
}

getOAuth2Claim

Success

Authorizations:

api_token

path Parameters

authServerId required	string
claimId required	string

Responses

Response Schema: application/json

	object
alwaysIncludeInToken	boolean
claimType	string Enum: "IDENTITY" "RESOURCE"
	object (OAuth2ClaimConditions)
group_filter_type	string Enum: "STARTS_WITH" "EQUALS" "CONTAINS" "REGEX"
id	string
name	string
status	string Enum: "ACTIVE" "INACTIVE"
system	boolean
value	string
valueType	string Enum: "EXPRESSION" "GROUPS" "SYSTEM"

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"alwaysIncludeInToken": true,
"claimType": "IDENTITY",
"conditions": {"scopes": ["string"
]
},
"group_filter_type": "STARTS_WITH",
"id": "string",
"name": "string",
"status": "ACTIVE",
"system": true,
"value": "string",
"valueType": "EXPRESSION"
}

updateOAuth2Claim

Success

Authorizations:

api_token

path Parameters

authServerId required	string
claimId required	string

Request Body schema: application/json

alwaysIncludeInToken	boolean
claimType	string Enum: "IDENTITY" "RESOURCE"
	object (OAuth2ClaimConditions)
group_filter_type	string Enum: "STARTS_WITH" "EQUALS" "CONTAINS" "REGEX"
name	string
status	string Enum: "ACTIVE" "INACTIVE"
system	boolean
value	string
valueType	string Enum: "EXPRESSION" "GROUPS" "SYSTEM"

Responses

Response Schema: application/json

	object
alwaysIncludeInToken	boolean
claimType	string Enum: "IDENTITY" "RESOURCE"
	object (OAuth2ClaimConditions)
group_filter_type	string Enum: "STARTS_WITH" "EQUALS" "CONTAINS" "REGEX"
id	string
name	string
status	string Enum: "ACTIVE" "INACTIVE"
system	boolean
value	string
valueType	string Enum: "EXPRESSION" "GROUPS" "SYSTEM"

Request samples

Content type

application/json

{"alwaysIncludeInToken": true,
"claimType": "IDENTITY",
"conditions": {"scopes": ["string"
]
},
"group_filter_type": "STARTS_WITH",
"name": "string",
"status": "ACTIVE",
"system": true,
"value": "string",
"valueType": "EXPRESSION"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"alwaysIncludeInToken": true,
"claimType": "IDENTITY",
"conditions": {"scopes": ["string"
]
},
"group_filter_type": "STARTS_WITH",
"id": "string",
"name": "string",
"status": "ACTIVE",
"system": true,
"value": "string",
"valueType": "EXPRESSION"
}

deleteOAuth2Claim

Success

Authorizations:

api_token

path Parameters

authServerId required	string
claimId required	string

Responses

listOAuth2ClientsForAuthorizationServer

Success

Authorizations:

api_token

path Parameters

authServerId

required

string

Responses

Response Schema: application/json

Array ()

	object
client_id	string
client_name	string
client_uri	string
logo_uri	string

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"client_id": "string",
"client_name": "string",
"client_uri": "string",
"logo_uri": "string"
}
]

listRefreshTokensForAuthorizationServerAndClient

Success

Authorizations:

api_token

path Parameters

authServerId required	string
clientId required	string

query Parameters

after	string
expand	string
limit	integer <int32> Default: -1

Responses

Response Schema: application/json

Array ()

	object
	object
clientId	string
created	string <date-time>
	object (OAuth2Actor)
expiresAt	string <date-time>
id	string
issuer	string
lastUpdated	string <date-time>
scopes	Array of strings
status	string Enum: "ACTIVE" "REVOKED"
userId	string

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": {"id": "string",
"type": "string"
},
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"issuer": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"scopes": ["string"
],
"status": "ACTIVE",
"userId": "string"
}
]

revokeRefreshTokensForAuthorizationServerAndClient

Success

Authorizations:

api_token

path Parameters

authServerId required	string
clientId required	string

Responses

getRefreshTokenForAuthorizationServerAndClient

Success

Authorizations:

api_token

path Parameters

authServerId required	string
clientId required	string
tokenId required	string

query Parameters

expand

string

Responses

Response Schema: application/json

	object
	object
clientId	string
created	string <date-time>
	object (OAuth2Actor)
expiresAt	string <date-time>
id	string
issuer	string
lastUpdated	string <date-time>
scopes	Array of strings
status	string Enum: "ACTIVE" "REVOKED"
userId	string

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": {"id": "string",
"type": "string"
},
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"issuer": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"scopes": ["string"
],
"status": "ACTIVE",
"userId": "string"
}

revokeRefreshTokenForAuthorizationServerAndClient

Success

Authorizations:

api_token

path Parameters

authServerId required	string
clientId required	string
tokenId required	string

Responses

listAuthorizationServerKeys

Success

Authorizations:

api_token

path Parameters

authServerId

required

string

Responses

Response Schema: application/json

Array ()

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}
]

rotateAuthorizationServerKeys

Success

Authorizations:

api_token

path Parameters

authServerId

required

string

Request Body schema: application/json

use	string Value: "sig"

Responses

Response Schema: application/json

Array ()

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Request samples

Content type

application/json

{"use": "sig"
}

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}
]

activateAuthorizationServer

Success

Authorizations:

api_token

path Parameters

authServerId

required

string

Responses

deactivateAuthorizationServer

Success

Authorizations:

api_token

path Parameters

authServerId

required

string

Responses

listAuthorizationServerPolicies

Success

Authorizations:

api_token

path Parameters

authServerId

required

string

Responses

Response Schema: application/json

Array ()

	object
	object
	object (PolicyRuleConditions)
created	string <date-time>
description	string
id	string
lastUpdated	string <date-time>
name	string
priority	integer
status	string Enum: "ACTIVE" "INACTIVE"
system	boolean
type	string (PolicyType) Enum: "OAUTH_AUTHORIZATION_POLICY" "OKTA_SIGN_ON" "PASSWORD" "IDP_DISCOVERY"

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"conditions": {"app": {"exclude": [{"id": "string",
"name": "string",
"type": "APP_TYPE"
}
],
"include": [{"id": "string",
"name": "string",
"type": "APP_TYPE"
}
]
},
"apps": {"exclude": ["string"
],
"include": ["string"
]
},
"authContext": {"authType": "ANY"
},
"authProvider": {"include": ["string"
],
"provider": "ACTIVE_DIRECTORY"
},
"beforeScheduledAction": {"duration": {"number": 0,
"unit": "string"
},
"lifecycleAction": {"status": "ACTIVE"
}
},
"clients": {"include": ["string"
]
},
"context": {"expression": "string"
},
"device": {"migrated": true,
"platform": {"supportedMDMFrameworks": ["AFW"
],
"types": ["IOS"
]
},
"rooted": true,
"trustLevel": "ANY"
},
"grantTypes": {"include": ["string"
]
},
"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"identityProvider": {"idpIds": ["string"
],
"provider": "ANY"
},
"mdmEnrollment": {"blockNonSafeAndroid": true,
"enrollment": "OMM"
},
"network": {"connection": "ANYWHERE",
"exclude": ["string"
],
"include": ["string"
]
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
},
"platform": {"exclude": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
],
"include": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
]
},
"risk": {"behaviors": ["string"
]
},
"riskScore": {"level": "string"
},
"scopes": {"include": ["string"
]
},
"userIdentifier": {"attribute": "string",
"patterns": [{"matchType": "SUFFIX",
"value": "string"
}
],
"type": "IDENTIFIER"
},
"userStatus": {"value": "ACTIVE"
},
"users": {"exclude": ["string"
],
"inactivity": {"number": 0,
"unit": "string"
},
"include": ["string"
],
"lifecycleExpiration": {"lifecycleStatus": "string",
"number": 0,
"unit": "string"
},
"passwordExpiration": {"number": 0,
"unit": "string"
},
"userLifecycleAttribute": {"attributeName": "string",
"matchingValue": "string"
}
}
},
"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"priority": 0,
"status": "ACTIVE",
"system": true,
"type": "OAUTH_AUTHORIZATION_POLICY"
}
]

createAuthorizationServerPolicy

Success

Authorizations:

api_token

path Parameters

authServerId

required

string

Request Body schema: application/json

	object (PolicyRuleConditions)
description	string
name	string
priority	integer
status	string Enum: "ACTIVE" "INACTIVE"
system	boolean
type	string (PolicyType) Enum: "OAUTH_AUTHORIZATION_POLICY" "OKTA_SIGN_ON" "PASSWORD" "IDP_DISCOVERY"

Responses

Response Schema: application/json

	object
	object
	object (PolicyRuleConditions)
created	string <date-time>
description	string
id	string
lastUpdated	string <date-time>
name	string
priority	integer
status	string Enum: "ACTIVE" "INACTIVE"
system	boolean
type	string (PolicyType) Enum: "OAUTH_AUTHORIZATION_POLICY" "OKTA_SIGN_ON" "PASSWORD" "IDP_DISCOVERY"

Request samples

Content type

application/json

{"conditions": {"app": {"exclude": [{"name": "string",
"type": "APP_TYPE"
}
],
"include": [{"name": "string",
"type": "APP_TYPE"
}
]
},
"apps": {"exclude": ["string"
],
"include": ["string"
]
},
"authContext": {"authType": "ANY"
},
"authProvider": {"include": ["string"
],
"provider": "ACTIVE_DIRECTORY"
},
"beforeScheduledAction": {"duration": {"number": 0,
"unit": "string"
},
"lifecycleAction": {"status": "ACTIVE"
}
},
"clients": {"include": ["string"
]
},
"context": {"expression": "string"
},
"device": {"migrated": true,
"platform": {"supportedMDMFrameworks": ["AFW"
],
"types": ["IOS"
]
},
"rooted": true,
"trustLevel": "ANY"
},
"grantTypes": {"include": ["string"
]
},
"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"identityProvider": {"idpIds": ["string"
],
"provider": "ANY"
},
"mdmEnrollment": {"blockNonSafeAndroid": true,
"enrollment": "OMM"
},
"network": {"connection": "ANYWHERE",
"exclude": ["string"
],
"include": ["string"
]
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
},
"platform": {"exclude": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
],
"include": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
]
},
"risk": {"behaviors": ["string"
]
},
"riskScore": {"level": "string"
},
"scopes": {"include": ["string"
]
},
"userIdentifier": {"attribute": "string",
"patterns": [{"matchType": "SUFFIX",
"value": "string"
}
],
"type": "IDENTIFIER"
},
"userStatus": {"value": "ACTIVE"
},
"users": {"exclude": ["string"
],
"inactivity": {"number": 0,
"unit": "string"
},
"include": ["string"
],
"lifecycleExpiration": {"lifecycleStatus": "string",
"number": 0,
"unit": "string"
},
"passwordExpiration": {"number": 0,
"unit": "string"
},
"userLifecycleAttribute": {"attributeName": "string",
"matchingValue": "string"
}
}
},
"description": "string",
"name": "string",
"priority": 0,
"status": "ACTIVE",
"system": true,
"type": "OAUTH_AUTHORIZATION_POLICY"
}

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"conditions": {"app": {"exclude": [{"id": "string",
"name": "string",
"type": "APP_TYPE"
}
],
"include": [{"id": "string",
"name": "string",
"type": "APP_TYPE"
}
]
},
"apps": {"exclude": ["string"
],
"include": ["string"
]
},
"authContext": {"authType": "ANY"
},
"authProvider": {"include": ["string"
],
"provider": "ACTIVE_DIRECTORY"
},
"beforeScheduledAction": {"duration": {"number": 0,
"unit": "string"
},
"lifecycleAction": {"status": "ACTIVE"
}
},
"clients": {"include": ["string"
]
},
"context": {"expression": "string"
},
"device": {"migrated": true,
"platform": {"supportedMDMFrameworks": ["AFW"
],
"types": ["IOS"
]
},
"rooted": true,
"trustLevel": "ANY"
},
"grantTypes": {"include": ["string"
]
},
"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"identityProvider": {"idpIds": ["string"
],
"provider": "ANY"
},
"mdmEnrollment": {"blockNonSafeAndroid": true,
"enrollment": "OMM"
},
"network": {"connection": "ANYWHERE",
"exclude": ["string"
],
"include": ["string"
]
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
},
"platform": {"exclude": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
],
"include": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
]
},
"risk": {"behaviors": ["string"
]
},
"riskScore": {"level": "string"
},
"scopes": {"include": ["string"
]
},
"userIdentifier": {"attribute": "string",
"patterns": [{"matchType": "SUFFIX",
"value": "string"
}
],
"type": "IDENTIFIER"
},
"userStatus": {"value": "ACTIVE"
},
"users": {"exclude": ["string"
],
"inactivity": {"number": 0,
"unit": "string"
},
"include": ["string"
],
"lifecycleExpiration": {"lifecycleStatus": "string",
"number": 0,
"unit": "string"
},
"passwordExpiration": {"number": 0,
"unit": "string"
},
"userLifecycleAttribute": {"attributeName": "string",
"matchingValue": "string"
}
}
},
"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"priority": 0,
"status": "ACTIVE",
"system": true,
"type": "OAUTH_AUTHORIZATION_POLICY"
}

getAuthorizationServerPolicy

Success

Authorizations:

api_token

path Parameters

authServerId required	string
policyId required	string

Responses

Response Schema: application/json

	object
	object
	object (PolicyRuleConditions)
created	string <date-time>
description	string
id	string
lastUpdated	string <date-time>
name	string
priority	integer
status	string Enum: "ACTIVE" "INACTIVE"
system	boolean
type	string (PolicyType) Enum: "OAUTH_AUTHORIZATION_POLICY" "OKTA_SIGN_ON" "PASSWORD" "IDP_DISCOVERY"

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"conditions": {"app": {"exclude": [{"id": "string",
"name": "string",
"type": "APP_TYPE"
}
],
"include": [{"id": "string",
"name": "string",
"type": "APP_TYPE"
}
]
},
"apps": {"exclude": ["string"
],
"include": ["string"
]
},
"authContext": {"authType": "ANY"
},
"authProvider": {"include": ["string"
],
"provider": "ACTIVE_DIRECTORY"
},
"beforeScheduledAction": {"duration": {"number": 0,
"unit": "string"
},
"lifecycleAction": {"status": "ACTIVE"
}
},
"clients": {"include": ["string"
]
},
"context": {"expression": "string"
},
"device": {"migrated": true,
"platform": {"supportedMDMFrameworks": ["AFW"
],
"types": ["IOS"
]
},
"rooted": true,
"trustLevel": "ANY"
},
"grantTypes": {"include": ["string"
]
},
"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"identityProvider": {"idpIds": ["string"
],
"provider": "ANY"
},
"mdmEnrollment": {"blockNonSafeAndroid": true,
"enrollment": "OMM"
},
"network": {"connection": "ANYWHERE",
"exclude": ["string"
],
"include": ["string"
]
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
},
"platform": {"exclude": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
],
"include": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
]
},
"risk": {"behaviors": ["string"
]
},
"riskScore": {"level": "string"
},
"scopes": {"include": ["string"
]
},
"userIdentifier": {"attribute": "string",
"patterns": [{"matchType": "SUFFIX",
"value": "string"
}
],
"type": "IDENTIFIER"
},
"userStatus": {"value": "ACTIVE"
},
"users": {"exclude": ["string"
],
"inactivity": {"number": 0,
"unit": "string"
},
"include": ["string"
],
"lifecycleExpiration": {"lifecycleStatus": "string",
"number": 0,
"unit": "string"
},
"passwordExpiration": {"number": 0,
"unit": "string"
},
"userLifecycleAttribute": {"attributeName": "string",
"matchingValue": "string"
}
}
},
"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"priority": 0,
"status": "ACTIVE",
"system": true,
"type": "OAUTH_AUTHORIZATION_POLICY"
}

updateAuthorizationServerPolicy

Success

Authorizations:

api_token

path Parameters

authServerId required	string
policyId required	string

Request Body schema: application/json

	object (PolicyRuleConditions)
description	string
name	string
priority	integer
status	string Enum: "ACTIVE" "INACTIVE"
system	boolean
type	string (PolicyType) Enum: "OAUTH_AUTHORIZATION_POLICY" "OKTA_SIGN_ON" "PASSWORD" "IDP_DISCOVERY"

Responses

Response Schema: application/json

	object
	object
	object (PolicyRuleConditions)
created	string <date-time>
description	string
id	string
lastUpdated	string <date-time>
name	string
priority	integer
status	string Enum: "ACTIVE" "INACTIVE"
system	boolean
type	string (PolicyType) Enum: "OAUTH_AUTHORIZATION_POLICY" "OKTA_SIGN_ON" "PASSWORD" "IDP_DISCOVERY"

Request samples

Content type

application/json

{"conditions": {"app": {"exclude": [{"name": "string",
"type": "APP_TYPE"
}
],
"include": [{"name": "string",
"type": "APP_TYPE"
}
]
},
"apps": {"exclude": ["string"
],
"include": ["string"
]
},
"authContext": {"authType": "ANY"
},
"authProvider": {"include": ["string"
],
"provider": "ACTIVE_DIRECTORY"
},
"beforeScheduledAction": {"duration": {"number": 0,
"unit": "string"
},
"lifecycleAction": {"status": "ACTIVE"
}
},
"clients": {"include": ["string"
]
},
"context": {"expression": "string"
},
"device": {"migrated": true,
"platform": {"supportedMDMFrameworks": ["AFW"
],
"types": ["IOS"
]
},
"rooted": true,
"trustLevel": "ANY"
},
"grantTypes": {"include": ["string"
]
},
"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"identityProvider": {"idpIds": ["string"
],
"provider": "ANY"
},
"mdmEnrollment": {"blockNonSafeAndroid": true,
"enrollment": "OMM"
},
"network": {"connection": "ANYWHERE",
"exclude": ["string"
],
"include": ["string"
]
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
},
"platform": {"exclude": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
],
"include": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
]
},
"risk": {"behaviors": ["string"
]
},
"riskScore": {"level": "string"
},
"scopes": {"include": ["string"
]
},
"userIdentifier": {"attribute": "string",
"patterns": [{"matchType": "SUFFIX",
"value": "string"
}
],
"type": "IDENTIFIER"
},
"userStatus": {"value": "ACTIVE"
},
"users": {"exclude": ["string"
],
"inactivity": {"number": 0,
"unit": "string"
},
"include": ["string"
],
"lifecycleExpiration": {"lifecycleStatus": "string",
"number": 0,
"unit": "string"
},
"passwordExpiration": {"number": 0,
"unit": "string"
},
"userLifecycleAttribute": {"attributeName": "string",
"matchingValue": "string"
}
}
},
"description": "string",
"name": "string",
"priority": 0,
"status": "ACTIVE",
"system": true,
"type": "OAUTH_AUTHORIZATION_POLICY"
}

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"conditions": {"app": {"exclude": [{"id": "string",
"name": "string",
"type": "APP_TYPE"
}
],
"include": [{"id": "string",
"name": "string",
"type": "APP_TYPE"
}
]
},
"apps": {"exclude": ["string"
],
"include": ["string"
]
},
"authContext": {"authType": "ANY"
},
"authProvider": {"include": ["string"
],
"provider": "ACTIVE_DIRECTORY"
},
"beforeScheduledAction": {"duration": {"number": 0,
"unit": "string"
},
"lifecycleAction": {"status": "ACTIVE"
}
},
"clients": {"include": ["string"
]
},
"context": {"expression": "string"
},
"device": {"migrated": true,
"platform": {"supportedMDMFrameworks": ["AFW"
],
"types": ["IOS"
]
},
"rooted": true,
"trustLevel": "ANY"
},
"grantTypes": {"include": ["string"
]
},
"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"identityProvider": {"idpIds": ["string"
],
"provider": "ANY"
},
"mdmEnrollment": {"blockNonSafeAndroid": true,
"enrollment": "OMM"
},
"network": {"connection": "ANYWHERE",
"exclude": ["string"
],
"include": ["string"
]
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
},
"platform": {"exclude": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
],
"include": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
]
},
"risk": {"behaviors": ["string"
]
},
"riskScore": {"level": "string"
},
"scopes": {"include": ["string"
]
},
"userIdentifier": {"attribute": "string",
"patterns": [{"matchType": "SUFFIX",
"value": "string"
}
],
"type": "IDENTIFIER"
},
"userStatus": {"value": "ACTIVE"
},
"users": {"exclude": ["string"
],
"inactivity": {"number": 0,
"unit": "string"
},
"include": ["string"
],
"lifecycleExpiration": {"lifecycleStatus": "string",
"number": 0,
"unit": "string"
},
"passwordExpiration": {"number": 0,
"unit": "string"
},
"userLifecycleAttribute": {"attributeName": "string",
"matchingValue": "string"
}
}
},
"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"priority": 0,
"status": "ACTIVE",
"system": true,
"type": "OAUTH_AUTHORIZATION_POLICY"
}

deleteAuthorizationServerPolicy

Success

Authorizations:

api_token

path Parameters

authServerId required	string
policyId required	string

Responses

activateAuthorizationServerPolicy

Activate Authorization Server Policy

Authorizations:

api_token

path Parameters

authServerId required	string
policyId required	string

Responses

deactivateAuthorizationServerPolicy

Deactivate Authorization Server Policy

Authorizations:

api_token

path Parameters

authServerId required	string
policyId required	string

Responses

listAuthorizationServerPolicyRules

Enumerates all policy rules for the specified Custom Authorization Server and Policy.

Authorizations:

api_token

path Parameters

authServerId required	string
policyId required	string

Responses

Response Schema: application/json

Array ()

	object (AuthorizationServerPolicyRuleActions)
	object (AuthorizationServerPolicyRuleConditions)
created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
priority	integer
status	string Default: "ACTIVE" Enum: "ACTIVE" "INACTIVE"
system	boolean Default: false
type	string Value: "RESOURCE_ACCESS"

Response samples

200

Content type

application/json

[{"created": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"priority": 0,
"status": "ACTIVE",
"system": false,
"type": "RESOURCE_ACCESS",
"conditions": {"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
},
"clients": {"include": ["string"
]
},
"grantTypes": {"include": ["string"
]
},
"scopes": {"include": ["string"
]
}
},
"actions": {"token": {"accessTokenLifetimeMinutes": 0,
"refreshTokenLifetimeMinutes": 0,
"refreshTokenWindowMinutes": 0,
"inlineHook": {"id": "string"
}
}
}
}
]

createAuthorizationServerPolicyRule

Creates a policy rule for the specified Custom Authorization Server and Policy.

Authorizations:

api_token

path Parameters

authServerId required	string
policyId required	string

Request Body schema: application/json

	object (AuthorizationServerPolicyRuleActions)
	object (AuthorizationServerPolicyRuleConditions)
name	string
priority	integer
status	string Default: "ACTIVE" Enum: "ACTIVE" "INACTIVE"
system	boolean Default: false
type	string Value: "RESOURCE_ACCESS"

Responses

Response Schema: application/json

	object (AuthorizationServerPolicyRuleActions)
	object (AuthorizationServerPolicyRuleConditions)
created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
priority	integer
status	string Default: "ACTIVE" Enum: "ACTIVE" "INACTIVE"
system	boolean Default: false
type	string Value: "RESOURCE_ACCESS"

Request samples

Content type

application/json

{"name": "string",
"priority": 0,
"status": "ACTIVE",
"system": false,
"type": "RESOURCE_ACCESS",
"conditions": {"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
},
"clients": {"include": ["string"
]
},
"grantTypes": {"include": ["string"
]
},
"scopes": {"include": ["string"
]
}
},
"actions": {"token": {"accessTokenLifetimeMinutes": 0,
"refreshTokenLifetimeMinutes": 0,
"refreshTokenWindowMinutes": 0,
"inlineHook": {"id": "string"
}
}
}
}

Response samples

200

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"priority": 0,
"status": "ACTIVE",
"system": false,
"type": "RESOURCE_ACCESS",
"conditions": {"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
},
"clients": {"include": ["string"
]
},
"grantTypes": {"include": ["string"
]
},
"scopes": {"include": ["string"
]
}
},
"actions": {"token": {"accessTokenLifetimeMinutes": 0,
"refreshTokenLifetimeMinutes": 0,
"refreshTokenWindowMinutes": 0,
"inlineHook": {"id": "string"
}
}
}
}

getAuthorizationServerPolicyRule

Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy.

Authorizations:

api_token

path Parameters

authServerId required	string
policyId required	string
ruleId required	string

Responses

Response Schema: application/json

	object (AuthorizationServerPolicyRuleActions)
	object (AuthorizationServerPolicyRuleConditions)
created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
priority	integer
status	string Default: "ACTIVE" Enum: "ACTIVE" "INACTIVE"
system	boolean Default: false
type	string Value: "RESOURCE_ACCESS"

Response samples

200

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"priority": 0,
"status": "ACTIVE",
"system": false,
"type": "RESOURCE_ACCESS",
"conditions": {"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
},
"clients": {"include": ["string"
]
},
"grantTypes": {"include": ["string"
]
},
"scopes": {"include": ["string"
]
}
},
"actions": {"token": {"accessTokenLifetimeMinutes": 0,
"refreshTokenLifetimeMinutes": 0,
"refreshTokenWindowMinutes": 0,
"inlineHook": {"id": "string"
}
}
}
}

updateAuthorizationServerPolicyRule

Updates the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy.

Authorizations:

api_token

path Parameters

authServerId required	string
policyId required	string
ruleId required	string

Request Body schema: application/json

	object (AuthorizationServerPolicyRuleActions)
	object (AuthorizationServerPolicyRuleConditions)
name	string
priority	integer
status	string Default: "ACTIVE" Enum: "ACTIVE" "INACTIVE"
system	boolean Default: false
type	string Value: "RESOURCE_ACCESS"

Responses

Response Schema: application/json

	object (AuthorizationServerPolicyRuleActions)
	object (AuthorizationServerPolicyRuleConditions)
created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
priority	integer
status	string Default: "ACTIVE" Enum: "ACTIVE" "INACTIVE"
system	boolean Default: false
type	string Value: "RESOURCE_ACCESS"

Request samples

Content type

application/json

{"name": "string",
"priority": 0,
"status": "ACTIVE",
"system": false,
"type": "RESOURCE_ACCESS",
"conditions": {"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
},
"clients": {"include": ["string"
]
},
"grantTypes": {"include": ["string"
]
},
"scopes": {"include": ["string"
]
}
},
"actions": {"token": {"accessTokenLifetimeMinutes": 0,
"refreshTokenLifetimeMinutes": 0,
"refreshTokenWindowMinutes": 0,
"inlineHook": {"id": "string"
}
}
}
}

Response samples

200

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"priority": 0,
"status": "ACTIVE",
"system": false,
"type": "RESOURCE_ACCESS",
"conditions": {"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
},
"clients": {"include": ["string"
]
},
"grantTypes": {"include": ["string"
]
},
"scopes": {"include": ["string"
]
}
},
"actions": {"token": {"accessTokenLifetimeMinutes": 0,
"refreshTokenLifetimeMinutes": 0,
"refreshTokenWindowMinutes": 0,
"inlineHook": {"id": "string"
}
}
}
}

deleteAuthorizationServerPolicyRule

Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy.

Authorizations:

api_token

path Parameters

authServerId required	string
policyId required	string
ruleId required	string

Responses

activateAuthorizationServerPolicyRule

Activate Authorization Server Policy Rule

Authorizations:

api_token

path Parameters

authServerId required	string
policyId required	string
ruleId required	string

Responses

deactivateAuthorizationServerPolicyRule

Deactivate Authorization Server Policy Rule

Authorizations:

api_token

path Parameters

authServerId required	string
policyId required	string
ruleId required	string

Responses

listOAuth2Scopes

Success

Authorizations:

api_token

path Parameters

authServerId

required

string

query Parameters

cursor	string
filter	string
limit	integer <int32> Default: -1
q	string

Responses

Response Schema: application/json

Array ()

consent	string Enum: "REQUIRED" "IMPLICIT" "ADMIN"
default	boolean
description	string
displayName	string
id	string
metadataPublish	string Enum: "ALL_CLIENTS" "NO_CLIENTS"
name	string
system	boolean

Response samples

200

Content type

application/json

[{"consent": "REQUIRED",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"metadataPublish": "ALL_CLIENTS",
"name": "string",
"system": true
}
]

createOAuth2Scope

Success

Authorizations:

api_token

path Parameters

authServerId

required

string

Request Body schema: application/json

consent	string Enum: "REQUIRED" "IMPLICIT" "ADMIN"
default	boolean
description	string
displayName	string
metadataPublish	string Enum: "ALL_CLIENTS" "NO_CLIENTS"
name	string
system	boolean

Responses

Response Schema: application/json

consent	string Enum: "REQUIRED" "IMPLICIT" "ADMIN"
default	boolean
description	string
displayName	string
id	string
metadataPublish	string Enum: "ALL_CLIENTS" "NO_CLIENTS"
name	string
system	boolean

Request samples

Content type

application/json

{"consent": "REQUIRED",
"default": true,
"description": "string",
"displayName": "string",
"metadataPublish": "ALL_CLIENTS",
"name": "string",
"system": true
}

Response samples

200

Content type

application/json

{"consent": "REQUIRED",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"metadataPublish": "ALL_CLIENTS",
"name": "string",
"system": true
}

getOAuth2Scope

Success

Authorizations:

api_token

path Parameters

authServerId required	string
scopeId required	string

Responses

Response Schema: application/json

consent	string Enum: "REQUIRED" "IMPLICIT" "ADMIN"
default	boolean
description	string
displayName	string
id	string
metadataPublish	string Enum: "ALL_CLIENTS" "NO_CLIENTS"
name	string
system	boolean

Response samples

200

Content type

application/json

{"consent": "REQUIRED",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"metadataPublish": "ALL_CLIENTS",
"name": "string",
"system": true
}

updateOAuth2Scope

Success

Authorizations:

api_token

path Parameters

authServerId required	string
scopeId required	string

Request Body schema: application/json

consent	string Enum: "REQUIRED" "IMPLICIT" "ADMIN"
default	boolean
description	string
displayName	string
metadataPublish	string Enum: "ALL_CLIENTS" "NO_CLIENTS"
name	string
system	boolean

Responses

Response Schema: application/json

consent	string Enum: "REQUIRED" "IMPLICIT" "ADMIN"
default	boolean
description	string
displayName	string
id	string
metadataPublish	string Enum: "ALL_CLIENTS" "NO_CLIENTS"
name	string
system	boolean

Request samples

Content type

application/json

{"consent": "REQUIRED",
"default": true,
"description": "string",
"displayName": "string",
"metadataPublish": "ALL_CLIENTS",
"name": "string",
"system": true
}

Response samples

200

Content type

application/json

{"consent": "REQUIRED",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"metadataPublish": "ALL_CLIENTS",
"name": "string",
"system": true
}

deleteOAuth2Scope

Success

Authorizations:

api_token

path Parameters

authServerId required	string
scopeId required	string

Responses

AuthorizationServerPolicy

CAPTCHA

List CAPTCHA instances

Enumerates CAPTCHA instances in your organization with pagination. A subset of CAPTCHA instances can be returned that match a supported filter expression or query.

Authorizations:

api_tokenoauth2 (okta.captchas.read)

Responses

Response Schema: application/json

Array ()

	object
id	string
name	string
siteKey	string
type	string Enum: "HCAPTCHA" "RECAPTCHA_V2"

Response samples

200

Content type

application/json

[{"id": "abcd1234",
"name": "myHCaptcha",
"siteKey": "xxxxxxxxxxx",
"type": "HCAPTCHA",
"_link": {"self": {"href": "https://your-subdomain.okta.com/api/v1/captchas/abcd1234",
"hints": {"allow": ["GET",
"POST",
"PUT",
"DELETE"
]
}
}
}
},
{"id": "abcd4567",
"name": "myReCaptcha",
"siteKey": "yyyyyyyyyyyyyyy",
"type": "RECAPTCHA_V2",
"_link": {"self": {"href": "https://your-subdomain.okta.com/api/v1/captchas/abcd4567",
"hints": {"allow": ["GET",
"POST",
"PUT",
"DELETE"
]
}
}
}
}
]

Create new CAPTCHA instance

Adds a new CAPTCHA instance to your organization. In current release, we only allow one CAPTCHA instance per org.

Authorizations:

api_tokenoauth2 (okta.captchas.manage)

Request Body schema: application/json

name	string
secretKey	string
siteKey	string
type	string Enum: "HCAPTCHA" "RECAPTCHA_V2"

Responses

Response Schema: application/json

	object
id	string
name	string
siteKey	string
type	string Enum: "HCAPTCHA" "RECAPTCHA_V2"

Request samples

Content type

application/json

{"name": "myHCaptcha",
"secretKey": "xxxxxxxxxxx",
"siteKey": "xxxxxxxxxxx",
"type": "HCAPTCHA"
}

Response samples

201
403

Content type

application/json

{"id": "abcd1234",
"name": "myHCaptcha",
"siteKey": "xxxxxxxxxxx",
"type": "HCAPTCHA",
"_link": {"self": {"href": "https://your-subdomain.okta.com/api/v1/captchas/abcd1234",
"hints": {"allow": ["GET",
"POST",
"PUT",
"DELETE"
]
}
}
}
}

Get CAPTCHA Instance

Fetches a CAPTCHA instance by id.

Authorizations:

api_tokenoauth2 (okta.captchas.read)

path Parameters

captchaId

required

string

Example: abcd1234

id of the CAPTCHA

Responses

Response Schema: application/json

	object
id	string
name	string
siteKey	string
type	string Enum: "HCAPTCHA" "RECAPTCHA_V2"

Response samples

200
404

Content type

application/json

{"id": "abcd1234",
"name": "myHCaptcha",
"siteKey": "xxxxxxxxxxx",
"type": "HCAPTCHA",
"_link": {"self": {"href": "https://your-subdomain.okta.com/api/v1/captchas/abcd1234",
"hints": {"allow": ["GET",
"POST",
"PUT",
"DELETE"
]
}
}
}
}

Update CAPTCHA instance

Update a CAPTCHA instance by id.

Authorizations:

api_tokenoauth2 (okta.captchas.manage)

path Parameters

captchaId

required

string

Example: abcd1234

id of the CAPTCHA

Request Body schema: application/json

name	string
secretKey	string
siteKey	string
type	string Enum: "HCAPTCHA" "RECAPTCHA_V2"

Responses

Response Schema: application/json

	object
id	string
name	string
siteKey	string
type	string Enum: "HCAPTCHA" "RECAPTCHA_V2"

Request samples

Content type

application/json

{"name": "myHCaptcha",
"secretKey": "xxxxxxxxxxx",
"siteKey": "xxxxxxxxxxx",
"type": "HCAPTCHA"
}

Response samples

200
400
404

Content type

application/json

{"id": "abcd1234",
"name": "myHCaptcha",
"siteKey": "xxxxxxxxxxx",
"type": "HCAPTCHA",
"_link": {"self": {"href": "https://your-subdomain.okta.com/api/v1/captchas/abcd1234",
"hints": {"allow": ["GET",
"POST",
"PUT",
"DELETE"
]
}
}
}
}

Delete CAPTCHA Instance

Delete a CAPTCHA instance by id.

Authorizations:

api_tokenoauth2 (okta.captchas.manage)

path Parameters

captchaId

required

string

Example: abcd1234

id of the CAPTCHA

Responses

Response samples

403
404

Content type

application/json

{"errorCode": "E0000149",
"errorSummary": "Current CAPTCHA is associated with org-wide settings, cannot be removed.",
"errorLink": "E0000149",
"errorId": "samplezsusshPdiTWiITwqBt8",
"errorCauses": [ ]
}

Partial Update CAPTCHA instance

Partially update a CAPTCHA instance by id.

Authorizations:

api_tokenoauth2 (okta.captchas.manage)

path Parameters

captchaId

required

string

Example: abcd1234

id of the CAPTCHA

Request Body schema: application/json

name	string
secretKey	string
siteKey	string
type	string Enum: "HCAPTCHA" "RECAPTCHA_V2"

Responses

Response Schema: application/json

	object
id	string
name	string
siteKey	string
type	string Enum: "HCAPTCHA" "RECAPTCHA_V2"

Request samples

Content type

application/json

{"name": "myHCaptcha",
"siteKey": "xxxxxxxxxxx",
"type": "HCAPTCHA"
}

Response samples

200
400
404

Content type

application/json

{"id": "abcd1234",
"name": "myHCaptcha",
"siteKey": "xxxxxxxxxxx",
"type": "HCAPTCHA",
"_link": {"self": {"href": "https://your-subdomain.okta.com/api/v1/captchas/abcd1234",
"hints": {"allow": ["GET",
"POST",
"PUT",
"DELETE"
]
}
}
}
}

Common

Domain

List Domains

List all verified custom Domains for the org.

Authorizations:

api_token

Responses

Response Schema: application/json

Array of objects (DomainResponse)

Response samples

200

Content type

application/json

{"domains": [{"certificateSourceType": "MANUAL",
"dnsRecords": [{"expiration": "string",
"fqdn": "string",
"recordType": "TXT",
"values": ["string"
]
}
],
"domain": "string",
"id": "string",
"_links": {"certificate": { },
"self": { },
"verify": { }
},
"publicCertificate": {"expiration": "string",
"fingerprint": "string",
"subject": "string"
},
"validationStatus": "NOT_STARTED"
}
]
}

Create Domain

Creates your domain.

Authorizations:

api_token

Request Body schema: application/json

certificateSourceType	string (DomainCertificateSourceType) Value: "MANUAL"
	Array of objects (DNSRecord)
domain	string
id	string
	object (DomainCertificateMetadata)
validationStatus	string (DomainValidationStatus) Enum: "NOT_STARTED" "IN_PROGRESS" "VERIFIED" "COMPLETED"

Responses

Response Schema: application/json

	object (DomainLinks)
certificateSourceType	string Value: "MANUAL"
	Array of objects (DNSRecord)
domain	string
id	string
	object (DomainCertificateMetadata)
validationStatus	string Enum: "NOT_STARTED" "IN_PROGRESS" "VERIFIED" "COMPLETED"

Request samples

Content type

application/json

{"certificateSourceType": "MANUAL",
"dnsRecords": [{"expiration": "string",
"fqdn": "string",
"recordType": "TXT",
"values": ["string"
]
}
],
"domain": "string",
"id": "string",
"publicCertificate": {"expiration": "string",
"fingerprint": "string",
"subject": "string"
},
"validationStatus": "NOT_STARTED"
}

Response samples

200

Content type

application/json

{"certificateSourceType": "MANUAL",
"dnsRecords": [{"expiration": "string",
"fqdn": "string",
"recordType": "TXT",
"values": ["string"
]
}
],
"domain": "string",
"id": "string",
"_links": {"certificate": { },
"self": { },
"verify": { }
},
"publicCertificate": {"expiration": "string",
"fingerprint": "string",
"subject": "string"
},
"validationStatus": "NOT_STARTED"
}

Verify Domain

Verifies the Domain by id.

Authorizations:

api_token

path Parameters

domainId

required

string

Responses

Response Schema: application/json

	object (DomainLinks)
certificateSourceType	string Value: "MANUAL"
	Array of objects (DNSRecord)
domain	string
id	string
	object (DomainCertificateMetadata)
validationStatus	string Enum: "NOT_STARTED" "IN_PROGRESS" "VERIFIED" "COMPLETED"

Response samples

200

Content type

application/json

{"certificateSourceType": "MANUAL",
"dnsRecords": [{"expiration": "string",
"fqdn": "string",
"recordType": "TXT",
"values": ["string"
]
}
],
"domain": "string",
"id": "string",
"_links": {"certificate": { },
"self": { },
"verify": { }
},
"publicCertificate": {"expiration": "string",
"fingerprint": "string",
"subject": "string"
},
"validationStatus": "NOT_STARTED"
}

Create Certificate

Creates the Certificate for the Domain.

Authorizations:

api_token

path Parameters

domainId

required

string

Request Body schema: application/json

certificate	string
certificateChain	string
privateKey	string
type	string (DomainCertificateType) Value: "PEM"

Responses

Request samples

Content type

application/json

{"certificate": "string",
"certificateChain": "string",
"privateKey": "string",
"type": "PEM"
}

Get Domain

Fetches a Domain by id.

Authorizations:

api_token

path Parameters

domainId

required

string

Responses

Response Schema: application/json

	object (DomainLinks)
certificateSourceType	string Value: "MANUAL"
	Array of objects (DNSRecord)
domain	string
id	string
	object (DomainCertificateMetadata)
validationStatus	string Enum: "NOT_STARTED" "IN_PROGRESS" "VERIFIED" "COMPLETED"

Response samples

200

Content type

application/json

{"certificateSourceType": "MANUAL",
"dnsRecords": [{"expiration": "string",
"fqdn": "string",
"recordType": "TXT",
"values": ["string"
]
}
],
"domain": "string",
"id": "string",
"_links": {"certificate": { },
"self": { },
"verify": { }
},
"publicCertificate": {"expiration": "string",
"fingerprint": "string",
"subject": "string"
},
"validationStatus": "NOT_STARTED"
}

Delete Domain

Deletes a Domain by id.

Authorizations:

api_token

path Parameters

domainId

required

string

Responses

EventHook

listEventHooks

Success

Authorizations:

api_token

Responses

Response Schema: application/json

Array ()

	object
	object (EventHookChannel)
created	string <date-time>
createdBy	string
	object (EventSubscriptions)
id	string
lastUpdated	string <date-time>
name	string
status	string Enum: "ACTIVE" "INACTIVE"
verificationStatus	string Enum: "UNVERIFIED" "VERIFIED"

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"channel": {"config": {"authScheme": {"key": "string",
"type": "HEADER",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string"
},
"type": "HTTP",
"version": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"events": {"items": ["string"
],
"type": "EVENT_TYPE"
},
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"verificationStatus": "UNVERIFIED"
}
]

createEventHook

Success

Authorizations:

api_token

Request Body schema: application/json

	object (EventHookChannel)
createdBy	string
	object (EventSubscriptions)
name	string
status	string Enum: "ACTIVE" "INACTIVE"
verificationStatus	string Enum: "UNVERIFIED" "VERIFIED"

Responses

Response Schema: application/json

	object
	object (EventHookChannel)
created	string <date-time>
createdBy	string
	object (EventSubscriptions)
id	string
lastUpdated	string <date-time>
name	string
status	string Enum: "ACTIVE" "INACTIVE"
verificationStatus	string Enum: "UNVERIFIED" "VERIFIED"

Request samples

Content type

application/json

{"channel": {"config": {"authScheme": {"key": "string",
"type": "HEADER",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string"
},
"type": "HTTP",
"version": "string"
},
"createdBy": "string",
"events": {"items": ["string"
],
"type": "EVENT_TYPE"
},
"name": "string",
"status": "ACTIVE",
"verificationStatus": "UNVERIFIED"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"channel": {"config": {"authScheme": {"key": "string",
"type": "HEADER",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string"
},
"type": "HTTP",
"version": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"events": {"items": ["string"
],
"type": "EVENT_TYPE"
},
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"verificationStatus": "UNVERIFIED"
}

getEventHook

Success

Authorizations:

api_token

path Parameters

eventHookId

required

string

Responses

Response Schema: application/json

	object
	object (EventHookChannel)
created	string <date-time>
createdBy	string
	object (EventSubscriptions)
id	string
lastUpdated	string <date-time>
name	string
status	string Enum: "ACTIVE" "INACTIVE"
verificationStatus	string Enum: "UNVERIFIED" "VERIFIED"

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"channel": {"config": {"authScheme": {"key": "string",
"type": "HEADER",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string"
},
"type": "HTTP",
"version": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"events": {"items": ["string"
],
"type": "EVENT_TYPE"
},
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"verificationStatus": "UNVERIFIED"
}

updateEventHook

Success

Authorizations:

api_token

path Parameters

eventHookId

required

string

Request Body schema: application/json

	object (EventHookChannel)
createdBy	string
	object (EventSubscriptions)
name	string
status	string Enum: "ACTIVE" "INACTIVE"
verificationStatus	string Enum: "UNVERIFIED" "VERIFIED"

Responses

Response Schema: application/json

	object
	object (EventHookChannel)
created	string <date-time>
createdBy	string
	object (EventSubscriptions)
id	string
lastUpdated	string <date-time>
name	string
status	string Enum: "ACTIVE" "INACTIVE"
verificationStatus	string Enum: "UNVERIFIED" "VERIFIED"

Request samples

Content type

application/json

{"channel": {"config": {"authScheme": {"key": "string",
"type": "HEADER",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string"
},
"type": "HTTP",
"version": "string"
},
"createdBy": "string",
"events": {"items": ["string"
],
"type": "EVENT_TYPE"
},
"name": "string",
"status": "ACTIVE",
"verificationStatus": "UNVERIFIED"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"channel": {"config": {"authScheme": {"key": "string",
"type": "HEADER",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string"
},
"type": "HTTP",
"version": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"events": {"items": ["string"
],
"type": "EVENT_TYPE"
},
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"verificationStatus": "UNVERIFIED"
}

deleteEventHook

Success

Authorizations:

api_token

path Parameters

eventHookId

required

string

Responses

activateEventHook

Success

Authorizations:

api_token

path Parameters

eventHookId

required

string

Responses

Response Schema: application/json

	object
	object (EventHookChannel)
created	string <date-time>
createdBy	string
	object (EventSubscriptions)
id	string
lastUpdated	string <date-time>
name	string
status	string Enum: "ACTIVE" "INACTIVE"
verificationStatus	string Enum: "UNVERIFIED" "VERIFIED"

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"channel": {"config": {"authScheme": {"key": "string",
"type": "HEADER",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string"
},
"type": "HTTP",
"version": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"events": {"items": ["string"
],
"type": "EVENT_TYPE"
},
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"verificationStatus": "UNVERIFIED"
}

deactivateEventHook

Success

Authorizations:

api_token

path Parameters

eventHookId

required

string

Responses

Response Schema: application/json

	object
	object (EventHookChannel)
created	string <date-time>
createdBy	string
	object (EventSubscriptions)
id	string
lastUpdated	string <date-time>
name	string
status	string Enum: "ACTIVE" "INACTIVE"
verificationStatus	string Enum: "UNVERIFIED" "VERIFIED"

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"channel": {"config": {"authScheme": {"key": "string",
"type": "HEADER",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string"
},
"type": "HTTP",
"version": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"events": {"items": ["string"
],
"type": "EVENT_TYPE"
},
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"verificationStatus": "UNVERIFIED"
}

verifyEventHook

Success

Authorizations:

api_token

path Parameters

eventHookId

required

string

Responses

Response Schema: application/json

	object
	object (EventHookChannel)
created	string <date-time>
createdBy	string
	object (EventSubscriptions)
id	string
lastUpdated	string <date-time>
name	string
status	string Enum: "ACTIVE" "INACTIVE"
verificationStatus	string Enum: "UNVERIFIED" "VERIFIED"

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"channel": {"config": {"authScheme": {"key": "string",
"type": "HEADER",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string"
},
"type": "HTTP",
"version": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"events": {"items": ["string"
],
"type": "EVENT_TYPE"
},
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"verificationStatus": "UNVERIFIED"
}

Feature

listFeatures

Success

Authorizations:

api_token

Responses

Response Schema: application/json

Array ()

	object
description	string
id	string
name	string
	object (FeatureStage)
status	string (EnabledStatus) Enum: "ENABLED" "DISABLED"
type	string (FeatureType) Value: "self-service"

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"description": "string",
"id": "string",
"name": "string",
"stage": {"state": "OPEN",
"value": "EA"
},
"status": "ENABLED",
"type": "self-service"
}
]

getFeature

Success

Authorizations:

api_token

path Parameters

featureId

required

string

Responses

Response Schema: application/json

	object
description	string
id	string
name	string
	object (FeatureStage)
status	string (EnabledStatus) Enum: "ENABLED" "DISABLED"
type	string (FeatureType) Value: "self-service"

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"description": "string",
"id": "string",
"name": "string",
"stage": {"state": "OPEN",
"value": "EA"
},
"status": "ENABLED",
"type": "self-service"
}

listFeatureDependencies

Success

Authorizations:

api_token

path Parameters

featureId

required

string

Responses

Response Schema: application/json

Array ()

	object
description	string
id	string
name	string
	object (FeatureStage)
status	string (EnabledStatus) Enum: "ENABLED" "DISABLED"
type	string (FeatureType) Value: "self-service"

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"description": "string",
"id": "string",
"name": "string",
"stage": {"state": "OPEN",
"value": "EA"
},
"status": "ENABLED",
"type": "self-service"
}
]

listFeatureDependents

Success

Authorizations:

api_token

path Parameters

featureId

required

string

Responses

Response Schema: application/json

Array ()

	object
description	string
id	string
name	string
	object (FeatureStage)
status	string (EnabledStatus) Enum: "ENABLED" "DISABLED"
type	string (FeatureType) Value: "self-service"

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"description": "string",
"id": "string",
"name": "string",
"stage": {"state": "OPEN",
"value": "EA"
},
"status": "ENABLED",
"type": "self-service"
}
]

updateFeatureLifecycle

Success

Authorizations:

api_token

path Parameters

featureId required	string
lifecycle required	string

query Parameters

mode

string

Responses

Response Schema: application/json

	object
description	string
id	string
name	string
	object (FeatureStage)
status	string (EnabledStatus) Enum: "ENABLED" "DISABLED"
type	string (FeatureType) Value: "self-service"

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"description": "string",
"id": "string",
"name": "string",
"stage": {"state": "OPEN",
"value": "EA"
},
"status": "ENABLED",
"type": "self-service"
}

Group

List Groups

Enumerates groups in your organization with pagination. A subset of groups can be returned that match a supported filter expression or query.

Authorizations:

api_token

query Parameters

after	string Specifies the pagination cursor for the next page of groups
expand	string If specified, it causes additional metadata to be included in the response.
limit	integer <int32> Default: 10000 Specifies the number of group results in a page
q	string Searches the name property of groups for matching value
search	string Filter expression for groups

Responses

Response Schema: application/json

Array ()

	object
	object
created	string <date-time>
id	string
lastMembershipUpdated	string <date-time>
lastUpdated	string <date-time>
objectClass	Array of strings
	object (GroupProfile)
type	string (GroupType) Enum: "OKTA_GROUP" "APP_GROUP" "BUILT_IN"

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastMembershipUpdated": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"objectClass": ["string"
],
"profile": {"description": "string",
"name": "string"
},
"type": "OKTA_GROUP"
}
]

Add Group

Adds a new group with OKTA_GROUP type to your organization.

Authorizations:

api_token

Request Body schema: application/json

	object (GroupProfile)
type	string (GroupType) Enum: "OKTA_GROUP" "APP_GROUP" "BUILT_IN"

Responses

Response Schema: application/json

	object
	object
created	string <date-time>
id	string
lastMembershipUpdated	string <date-time>
lastUpdated	string <date-time>
objectClass	Array of strings
	object (GroupProfile)
type	string (GroupType) Enum: "OKTA_GROUP" "APP_GROUP" "BUILT_IN"

Request samples

Content type

application/json

{"profile": {"description": "string",
"name": "string"
},
"type": "OKTA_GROUP"
}

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastMembershipUpdated": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"objectClass": ["string"
],
"profile": {"description": "string",
"name": "string"
},
"type": "OKTA_GROUP"
}

List Group Rules

Lists all group rules for your organization.

Authorizations:

api_token

query Parameters

after	string Specifies the pagination cursor for the next page of rules
expand	string If specified as `groupIdToGroupNameMap`, then show group names
limit	integer <int32> Default: 50 Specifies the number of rule results in a page
search	string Specifies the keyword to search fules for

Responses

Response Schema: application/json

Array ()

	object (GroupRuleAction)
	object (GroupRuleConditions)
created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
status	string (GroupRuleStatus) Enum: "ACTIVE" "INACTIVE" "INVALID"
type	string

Response samples

200

Content type

application/json

[{"actions": {"assignUserToGroups": {"groupIds": ["string"
]
}
},
"conditions": {"expression": {"type": "string",
"value": "string"
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
}
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"type": "string"
}
]

Create Group Rule

Creates a group rule to dynamically add users to the specified group if they match the condition

Authorizations:

api_token

Request Body schema: application/json

	object (GroupRuleAction)
	object (GroupRuleConditions)
name	string
status	string (GroupRuleStatus) Enum: "ACTIVE" "INACTIVE" "INVALID"
type	string

Responses

Response Schema: application/json

	object (GroupRuleAction)
	object (GroupRuleConditions)
created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
status	string (GroupRuleStatus) Enum: "ACTIVE" "INACTIVE" "INVALID"
type	string

Request samples

Content type

application/json

{"actions": {"assignUserToGroups": {"groupIds": ["string"
]
}
},
"conditions": {"expression": {"type": "string",
"value": "string"
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
}
},
"name": "string",
"status": "ACTIVE",
"type": "string"
}

Response samples

200

Content type

application/json

{"actions": {"assignUserToGroups": {"groupIds": ["string"
]
}
},
"conditions": {"expression": {"type": "string",
"value": "string"
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
}
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"type": "string"
}

Get Group Rule

Fetches a specific group rule by id from your organization

Authorizations:

api_token

path Parameters

ruleId

required

string

query Parameters

expand

string

Responses

Response Schema: application/json

	object (GroupRuleAction)
	object (GroupRuleConditions)
created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
status	string (GroupRuleStatus) Enum: "ACTIVE" "INACTIVE" "INVALID"
type	string

Response samples

200

Content type

application/json

{"actions": {"assignUserToGroups": {"groupIds": ["string"
]
}
},
"conditions": {"expression": {"type": "string",
"value": "string"
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
}
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"type": "string"
}

updateGroupRule

Updates a group rule. Only INACTIVE rules can be updated.

Authorizations:

api_token

path Parameters

ruleId

required

string

Request Body schema: application/json

	object (GroupRuleAction)
	object (GroupRuleConditions)
name	string
status	string (GroupRuleStatus) Enum: "ACTIVE" "INACTIVE" "INVALID"
type	string

Responses

Response Schema: application/json

	object (GroupRuleAction)
	object (GroupRuleConditions)
created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
status	string (GroupRuleStatus) Enum: "ACTIVE" "INACTIVE" "INVALID"
type	string

Request samples

Content type

application/json

{"actions": {"assignUserToGroups": {"groupIds": ["string"
]
}
},
"conditions": {"expression": {"type": "string",
"value": "string"
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
}
},
"name": "string",
"status": "ACTIVE",
"type": "string"
}

Response samples

200

Content type

application/json

{"actions": {"assignUserToGroups": {"groupIds": ["string"
]
}
},
"conditions": {"expression": {"type": "string",
"value": "string"
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
}
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"type": "string"
}

Delete a group Rule

Removes a specific group rule by id from your organization

Authorizations:

api_token

path Parameters

ruleId

required

string

query Parameters

removeUsers

boolean

Indicates whether to keep or remove users from groups assigned by this rule.

Responses

Activate a group Rule

Activates a specific group rule by id from your organization

Authorizations:

api_token

path Parameters

ruleId

required

string

Responses

Deactivate a group Rule

Deactivates a specific group rule by id from your organization

Authorizations:

api_token

path Parameters

ruleId

required

string

Responses

List Group Rules

Fetches a group from your organization.

Authorizations:

api_token

path Parameters

groupId

required

string

Responses

Response Schema: application/json

	object
	object
created	string <date-time>
id	string
lastMembershipUpdated	string <date-time>
lastUpdated	string <date-time>
objectClass	Array of strings
	object (GroupProfile)
type	string (GroupType) Enum: "OKTA_GROUP" "APP_GROUP" "BUILT_IN"

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastMembershipUpdated": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"objectClass": ["string"
],
"profile": {"description": "string",
"name": "string"
},
"type": "OKTA_GROUP"
}

Update Group

Updates the profile for a group with OKTA_GROUP type from your organization.

Authorizations:

api_token

path Parameters

groupId

required

string

Request Body schema: application/json

	object (GroupProfile)
type	string (GroupType) Enum: "OKTA_GROUP" "APP_GROUP" "BUILT_IN"

Responses

Response Schema: application/json

	object
	object
created	string <date-time>
id	string
lastMembershipUpdated	string <date-time>
lastUpdated	string <date-time>
objectClass	Array of strings
	object (GroupProfile)
type	string (GroupType) Enum: "OKTA_GROUP" "APP_GROUP" "BUILT_IN"

Request samples

Content type

application/json

{"profile": {"description": "string",
"name": "string"
},
"type": "OKTA_GROUP"
}

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastMembershipUpdated": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"objectClass": ["string"
],
"profile": {"description": "string",
"name": "string"
},
"type": "OKTA_GROUP"
}

Remove Group

Removes a group with OKTA_GROUP type from your organization.

Authorizations:

api_token

path Parameters

groupId

required

string

Responses

List Assigned Applications

Enumerates all applications that are assigned to a group.

Authorizations:

api_token

path Parameters

groupId

required

string

query Parameters

after	string Specifies the pagination cursor for the next page of apps
limit	integer <int32> Default: 20 Specifies the number of app results for a page

Responses

Response Schema: application/json

Array ()

	object (SchemeApplicationCredentials)
	object (AutoLoginApplicationSettings)

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"accessibility": {"errorRedirectUrl": "string",
"loginRedirectUrl": "string",
"selfService": true
},
"created": "2019-08-24T14:15:22Z",
"credentials": {"signing": {"kid": "string",
"lastRotated": "2019-08-24T14:15:22Z",
"nextRotation": "2019-08-24T14:15:22Z",
"rotationMode": "string",
"use": "sig"
},
"userNameTemplate": {"suffix": "string",
"template": "string",
"type": "string"
}
},
"features": ["string"
],
"id": "string",
"label": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"licensing": {"seatCount": 0
},
"name": "string",
"profile": {"property1": { },
"property2": { }
},
"settings": {"app": { },
"implicitAssignment": true,
"inlineHookId": "string",
"notifications": {"vpn": {"helpUrl": "string",
"message": "string",
"network": {"connection": "string",
"exclude": ["string"
],
"include": ["string"
]
}
}
},
"notes": {"admin": "string",
"enduser": "string"
}
},
"signOnMode": "BOOKMARK",
"status": "ACTIVE",
"visibility": {"appLinks": {"property1": true,
"property2": true
},
"autoLaunch": true,
"autoSubmitToolbar": true,
"hide": {"iOS": true,
"web": true
}
}
}
]

listGroupAssignedRoles

Success

Authorizations:

api_token

path Parameters

groupId

required

string

query Parameters

expand

string

Responses

Response Schema: application/json

Array ()

	object
	object
assignmentType	string (RoleAssignmentType) Enum: "GROUP" "USER"
created	string <date-time>
description	string
id	string
label	string
lastUpdated	string <date-time>
status	string (RoleStatus) Enum: "ACTIVE" "INACTIVE"
type	string (RoleType) Enum: "SUPER_ADMIN" "ORG_ADMIN" "APP_ADMIN" "USER_ADMIN" "HELP_DESK_ADMIN" "READ_ONLY_ADMIN" "MOBILE_ADMIN" "API_ACCESS_MANAGEMENT_ADMIN" "REPORT_ADMIN"

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"assignmentType": "GROUP",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"label": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"status": "ACTIVE",
"type": "SUPER_ADMIN"
}
]

assignRoleToGroup

Assigns a Role to a Group

Authorizations:

api_token

path Parameters

groupId

required

string

query Parameters

disableNotifications

string

Request Body schema: application/json

type	string (RoleType) Enum: "SUPER_ADMIN" "ORG_ADMIN" "APP_ADMIN" "USER_ADMIN" "HELP_DESK_ADMIN" "READ_ONLY_ADMIN" "MOBILE_ADMIN" "API_ACCESS_MANAGEMENT_ADMIN" "REPORT_ADMIN"

Responses

Response Schema: application/json

	object
	object
assignmentType	string (RoleAssignmentType) Enum: "GROUP" "USER"
created	string <date-time>
description	string
id	string
label	string
lastUpdated	string <date-time>
status	string (RoleStatus) Enum: "ACTIVE" "INACTIVE"
type	string (RoleType) Enum: "SUPER_ADMIN" "ORG_ADMIN" "APP_ADMIN" "USER_ADMIN" "HELP_DESK_ADMIN" "READ_ONLY_ADMIN" "MOBILE_ADMIN" "API_ACCESS_MANAGEMENT_ADMIN" "REPORT_ADMIN"

Request samples

Content type

application/json

{"type": "SUPER_ADMIN"
}

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"assignmentType": "GROUP",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"label": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"status": "ACTIVE",
"type": "SUPER_ADMIN"
}

getRole

Success

Authorizations:

api_token

path Parameters

groupId required	string
roleId required	string

Responses

Response Schema: application/json

	object
	object
assignmentType	string (RoleAssignmentType) Enum: "GROUP" "USER"
created	string <date-time>
description	string
id	string
label	string
lastUpdated	string <date-time>
status	string (RoleStatus) Enum: "ACTIVE" "INACTIVE"
type	string (RoleType) Enum: "SUPER_ADMIN" "ORG_ADMIN" "APP_ADMIN" "USER_ADMIN" "HELP_DESK_ADMIN" "READ_ONLY_ADMIN" "MOBILE_ADMIN" "API_ACCESS_MANAGEMENT_ADMIN" "REPORT_ADMIN"

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"assignmentType": "GROUP",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"label": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"status": "ACTIVE",
"type": "SUPER_ADMIN"
}

removeRoleFromGroup

Unassigns a Role from a Group

Authorizations:

api_token

path Parameters

groupId required	string
roleId required	string

Responses

listApplicationTargetsForApplicationAdministratorRoleForGroup

Lists all App targets for an APP_ADMIN Role assigned to a Group. This methods return list may include full Applications or Instances. The response for an instance will have an ID value, while Application will not have an ID.

Authorizations:

api_token

path Parameters

groupId required	string
roleId required	string

query Parameters

after	string
limit	integer <int32> Default: 20

Responses

Response Schema: application/json

Array ()

	object
category	string
description	string
displayName	string
features	Array of strings
id	string
lastUpdated	string <date-time>
name	string
signOnModes	Array of strings
status	string (CatalogApplicationStatus) Enum: "ACTIVE" "INACTIVE"
verificationStatus	string
website	string

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"displayName": "string",
"description": "string",
"status": "ACTIVE",
"lastUpdated": "2019-08-24T14:15:22Z",
"category": "string",
"verificationStatus": "string",
"website": "string",
"signOnModes": ["string"
],
"features": ["string"
],
"_links": {"property1": { },
"property2": { }
}
}
]

addApplicationTargetToAdminRoleGivenToGroup

Success

Authorizations:

api_token

path Parameters

appName required	string
groupId required	string
roleId required	string

Responses

removeApplicationTargetFromApplicationAdministratorRoleGivenToGroup

Success

Authorizations:

api_token

path Parameters

appName required	string
groupId required	string
roleId required	string

Responses

Add App Instance Target to App Administrator Role given to a Group

Authorizations:

api_token

path Parameters

applicationId required	string
appName required	string
groupId required	string
roleId required	string

Responses

Remove App Instance Target to App Administrator Role given to a Group

Authorizations:

api_token

path Parameters

applicationId required	string
appName required	string
groupId required	string
roleId required	string

Responses

List Group Targets for Group Role

Enumerates group targets for a group role.

Authorizations:

api_token

path Parameters

groupId required	string
roleId required	string

query Parameters

after	string
limit	integer <int32> Default: 20

Responses

Response Schema: application/json

Array ()

	object
	object
created	string <date-time>
id	string
lastMembershipUpdated	string <date-time>
lastUpdated	string <date-time>
objectClass	Array of strings
	object (GroupProfile)
type	string (GroupType) Enum: "OKTA_GROUP" "APP_GROUP" "BUILT_IN"

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastMembershipUpdated": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"objectClass": ["string"
],
"profile": {"description": "string",
"name": "string"
},
"type": "OKTA_GROUP"
}
]

Add Group Target for Group Role

Enumerates group targets for a group role.

path Parameters

groupId required	string
roleId required	string
targetGroupId required	string

Responses

Delete Group Target for Group Role

remove group target for a group role.

path Parameters

groupId required	string
roleId required	string
targetGroupId required	string

Responses

List Group Members

Enumerates all users that are a member of a group.

Authorizations:

api_token

path Parameters

groupId

required

string

query Parameters

after	string Specifies the pagination cursor for the next page of users
limit	integer <int32> Default: 1000 Specifies the number of user results in a page

Responses

Response Schema: application/json

Array ()

	object
	object
activated	string <date-time>
created	string <date-time>
	object (UserCredentials)
id	string
lastLogin	string <date-time>
lastUpdated	string <date-time>
passwordChanged	string <date-time>
	object (UserProfile)
status	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
statusChanged	string <date-time>
transitioningToStatus	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
	object (UserType)

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"activated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
},
"id": "string",
"lastLogin": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"passwordChanged": "2019-08-24T14:15:22Z",
"profile": {"city": "string",
"costCenter": "string",
"countryCode": "string",
"department": "string",
"displayName": "string",
"division": "string",
"email": "string",
"employeeNumber": "string",
"firstName": "string",
"honorificPrefix": "string",
"honorificSuffix": "string",
"lastName": "string",
"locale": "string",
"login": "string",
"manager": "string",
"managerId": "string",
"middleName": "string",
"mobilePhone": "string",
"nickName": "string",
"organization": "string",
"postalAddress": "string",
"preferredLanguage": "string",
"primaryPhone": "string",
"profileUrl": "string",
"secondEmail": "string",
"state": "string",
"streetAddress": "string",
"timezone": "string",
"title": "string",
"userType": "string",
"zipCode": "string"
},
"status": "ACTIVE",
"statusChanged": "2019-08-24T14:15:22Z",
"transitioningToStatus": "ACTIVE",
"type": {"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string"
}
}
]

Add User to Group

Adds a user to a group with 'OKTA_GROUP' type.

Authorizations:

api_token

path Parameters

groupId required	string
userId required	string

Responses

Remove User from Group

Removes a user from a group with 'OKTA_GROUP' type.

Authorizations:

api_token

path Parameters

groupId required	string
userId required	string

Responses

GroupRule

GroupSchema

Fetches the group schema

Authorizations:

api_token

Responses

Response Schema: application/json

	object
$schema	string
created	string
	object (GroupSchemaDefinitions)
description	string
id	string
lastUpdated	string
name	string
	object (UserSchemaProperties)
title	string
type	string

Response samples

200

Content type

application/json

{"$schema": "string",
"_links": {"property1": { },
"property2": { }
},
"created": "string",
"definitions": {"base": {"id": "string",
"properties": {"description": {"description": "string",
"enum": ["string"
],
"externalName": "string",
"externalNamespace": "string",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"maxLength": 0,
"minLength": 0,
"mutability": "string",
"oneOf": [{"const": "string",
"title": "string"
}
],
"permissions": [{"principal": "string",
"action": "string"
}
],
"required": true,
"scope": "SELF",
"title": "string",
"type": "string",
"union": "DISABLE",
"unique": "string"
},
"name": {"description": "string",
"enum": ["string"
],
"externalName": "string",
"externalNamespace": "string",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"maxLength": 0,
"minLength": 0,
"mutability": "string",
"oneOf": [{"const": "string",
"title": "string"
}
],
"permissions": [{"principal": "string",
"action": "string"
}
],
"required": true,
"scope": "SELF",
"title": "string",
"type": "string",
"union": "DISABLE",
"unique": "string"
}
},
"required": ["string"
],
"type": "string"
},
"custom": {"id": "string",
"properties": {"property1": {"description": "string",
"enum": ["string"
],
"externalName": "string",
"externalNamespace": "string",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"maxLength": 0,
"minLength": 0,
"mutability": "string",
"oneOf": [{"const": "string",
"title": "string"
}
],
"permissions": [{"principal": "string",
"action": "string"
}
],
"required": true,
"scope": "SELF",
"title": "string",
"type": "string",
"union": "DISABLE",
"unique": "string"
},
"property2": {"description": "string",
"enum": ["string"
],
"externalName": "string",
"externalNamespace": "string",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"maxLength": 0,
"minLength": 0,
"mutability": "string",
"oneOf": [{"const": "string",
"title": "string"
}
],
"permissions": [{"principal": "string",
"action": "string"
}
],
"required": true,
"scope": "SELF",
"title": "string",
"type": "string",
"union": "DISABLE",
"unique": "string"
}
},
"required": ["string"
],
"type": "string"
}
},
"description": "string",
"id": "string",
"lastUpdated": "string",
"name": "string",
"properties": {"profile": {"allOf": [{"$ref": "string"
}
]
}
},
"title": "string",
"type": "string"
}

Updates, adds ore removes one or more custom Group Profile properties in the schema

Authorizations:

api_token

Request Body schema: application/json

	object (GroupSchemaDefinitions)
description	string
	object (UserSchemaProperties)
title	string

Responses

Response Schema: application/json

	object
$schema	string
created	string
	object (GroupSchemaDefinitions)
description	string
id	string
lastUpdated	string
name	string
	object (UserSchemaProperties)
title	string
type	string

Request samples

Content type

application/json

{"definitions": {"base": {"properties": {"description": {"description": "string",
"enum": ["string"
],
"externalName": "string",
"externalNamespace": "string",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"maxLength": 0,
"minLength": 0,
"mutability": "string",
"oneOf": [{"const": "string",
"title": "string"
}
],
"permissions": [{"principal": "string",
"action": "string"
}
],
"required": true,
"scope": "SELF",
"title": "string",
"type": "string",
"union": "DISABLE",
"unique": "string"
},
"name": {"description": "string",
"enum": ["string"
],
"externalName": "string",
"externalNamespace": "string",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"maxLength": 0,
"minLength": 0,
"mutability": "string",
"oneOf": [{"const": "string",
"title": "string"
}
],
"permissions": [{"principal": "string",
"action": "string"
}
],
"required": true,
"scope": "SELF",
"title": "string",
"type": "string",
"union": "DISABLE",
"unique": "string"
}
},
"required": ["string"
],
"type": "string"
},
"custom": {"properties": {"property1": {"description": "string",
"enum": ["string"
],
"externalName": "string",
"externalNamespace": "string",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"maxLength": 0,
"minLength": 0,
"mutability": "string",
"oneOf": [{"const": "string",
"title": "string"
}
],
"permissions": [{"principal": "string",
"action": "string"
}
],
"required": true,
"scope": "SELF",
"title": "string",
"type": "string",
"union": "DISABLE",
"unique": "string"
},
"property2": {"description": "string",
"enum": ["string"
],
"externalName": "string",
"externalNamespace": "string",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"maxLength": 0,
"minLength": 0,
"mutability": "string",
"oneOf": [{"const": "string",
"title": "string"
}
],
"permissions": [{"principal": "string",
"action": "string"
}
],
"required": true,
"scope": "SELF",
"title": "string",
"type": "string",
"union": "DISABLE",
"unique": "string"
}
},
"required": ["string"
],
"type": "string"
}
},
"description": "string",
"properties": {"profile": {"allOf": [{"$ref": "string"
}
]
}
},
"title": "string"
}

Response samples

200

Content type

application/json

{"$schema": "string",
"_links": {"property1": { },
"property2": { }
},
"created": "string",
"definitions": {"base": {"id": "string",
"properties": {"description": {"description": "string",
"enum": ["string"
],
"externalName": "string",
"externalNamespace": "string",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"maxLength": 0,
"minLength": 0,
"mutability": "string",
"oneOf": [{"const": "string",
"title": "string"
}
],
"permissions": [{"principal": "string",
"action": "string"
}
],
"required": true,
"scope": "SELF",
"title": "string",
"type": "string",
"union": "DISABLE",
"unique": "string"
},
"name": {"description": "string",
"enum": ["string"
],
"externalName": "string",
"externalNamespace": "string",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"maxLength": 0,
"minLength": 0,
"mutability": "string",
"oneOf": [{"const": "string",
"title": "string"
}
],
"permissions": [{"principal": "string",
"action": "string"
}
],
"required": true,
"scope": "SELF",
"title": "string",
"type": "string",
"union": "DISABLE",
"unique": "string"
}
},
"required": ["string"
],
"type": "string"
},
"custom": {"id": "string",
"properties": {"property1": {"description": "string",
"enum": ["string"
],
"externalName": "string",
"externalNamespace": "string",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"maxLength": 0,
"minLength": 0,
"mutability": "string",
"oneOf": [{"const": "string",
"title": "string"
}
],
"permissions": [{"principal": "string",
"action": "string"
}
],
"required": true,
"scope": "SELF",
"title": "string",
"type": "string",
"union": "DISABLE",
"unique": "string"
},
"property2": {"description": "string",
"enum": ["string"
],
"externalName": "string",
"externalNamespace": "string",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"maxLength": 0,
"minLength": 0,
"mutability": "string",
"oneOf": [{"const": "string",
"title": "string"
}
],
"permissions": [{"principal": "string",
"action": "string"
}
],
"required": true,
"scope": "SELF",
"title": "string",
"type": "string",
"union": "DISABLE",
"unique": "string"
}
},
"required": ["string"
],
"type": "string"
}
},
"description": "string",
"id": "string",
"lastUpdated": "string",
"name": "string",
"properties": {"profile": {"allOf": [{"$ref": "string"
}
]
}
},
"title": "string",
"type": "string"
}

IdentityProvider

List Identity Providers

Enumerates IdPs in your organization with pagination. A subset of IdPs can be returned that match a supported filter expression or query.

Authorizations:

api_token

query Parameters

after	string Specifies the pagination cursor for the next page of IdPs
limit	integer <int32> Default: 20 Specifies the number of IdP results in a page
q	string Searches the name property of IdPs for matching value
type	string Filters IdPs by type

Responses

Response Schema: application/json

Array ()

	object
created	string <date-time>
id	string
issuerMode	string Enum: "ORG_URL" "CUSTOM_URL_DOMAIN"
lastUpdated	string <date-time>
name	string
	object (IdentityProviderPolicy)
	object (Protocol)
status	string Enum: "ACTIVE" "INACTIVE"
type	string

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"issuerMode": "ORG_URL",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"policy": {"accountLink": {"action": "AUTO",
"filter": {"groups": {"include": ["string"
]
}
}
},
"maxClockSkew": 0,
"provisioning": {"action": "AUTO",
"conditions": {"deprovisioned": {"action": "NONE"
},
"suspended": {"action": "NONE"
}
},
"groups": {"action": "NONE",
"assignments": ["string"
],
"filter": ["string"
],
"sourceAttributeName": "string"
},
"profileMaster": true
},
"subject": {"filter": "string",
"format": ["string"
],
"matchAttribute": "string",
"matchType": "USERNAME",
"userNameTemplate": {"template": "string"
}
}
},
"protocol": {"algorithms": {"request": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
},
"response": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
}
},
"credentials": {"client": {"client_id": "string",
"client_secret": "string"
},
"signing": {"kid": "string"
},
"trust": {"audience": "string",
"issuer": "string",
"kid": "string",
"revocation": "CRL",
"revocationCacheLifetime": 0
}
},
"endpoints": {"acs": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"authorization": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"jwks": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"metadata": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"slo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"sso": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"token": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"userInfo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
}
},
"issuer": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"relayState": {"format": "OPAQUE"
},
"scopes": ["string"
],
"settings": {"nameFormat": "string"
},
"type": "SAML2"
},
"status": "ACTIVE",
"type": "string"
}
]

Add Identity Provider

Adds a new IdP to your organization.

Authorizations:

api_token

Request Body schema: application/json

issuerMode	string Enum: "ORG_URL" "CUSTOM_URL_DOMAIN"
name	string
	object (IdentityProviderPolicy)
	object (Protocol)
status	string Enum: "ACTIVE" "INACTIVE"
type	string

Responses

Response Schema: application/json

	object
created	string <date-time>
id	string
issuerMode	string Enum: "ORG_URL" "CUSTOM_URL_DOMAIN"
lastUpdated	string <date-time>
name	string
	object (IdentityProviderPolicy)
	object (Protocol)
status	string Enum: "ACTIVE" "INACTIVE"
type	string

Request samples

Content type

application/json

{"issuerMode": "ORG_URL",
"name": "string",
"policy": {"accountLink": {"action": "AUTO",
"filter": {"groups": {"include": ["string"
]
}
}
},
"maxClockSkew": 0,
"provisioning": {"action": "AUTO",
"conditions": {"deprovisioned": {"action": "NONE"
},
"suspended": {"action": "NONE"
}
},
"groups": {"action": "NONE",
"assignments": ["string"
],
"filter": ["string"
],
"sourceAttributeName": "string"
},
"profileMaster": true
},
"subject": {"filter": "string",
"format": ["string"
],
"matchAttribute": "string",
"matchType": "USERNAME",
"userNameTemplate": {"template": "string"
}
}
},
"protocol": {"algorithms": {"request": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
},
"response": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
}
},
"credentials": {"client": {"client_id": "string",
"client_secret": "string"
},
"signing": {"kid": "string"
},
"trust": {"audience": "string",
"issuer": "string",
"kid": "string",
"revocation": "CRL",
"revocationCacheLifetime": 0
}
},
"endpoints": {"acs": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"authorization": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"jwks": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"metadata": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"slo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"sso": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"token": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"userInfo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
}
},
"issuer": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"relayState": {"format": "OPAQUE"
},
"scopes": ["string"
],
"settings": {"nameFormat": "string"
},
"type": "SAML2"
},
"status": "ACTIVE",
"type": "string"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"issuerMode": "ORG_URL",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"policy": {"accountLink": {"action": "AUTO",
"filter": {"groups": {"include": ["string"
]
}
}
},
"maxClockSkew": 0,
"provisioning": {"action": "AUTO",
"conditions": {"deprovisioned": {"action": "NONE"
},
"suspended": {"action": "NONE"
}
},
"groups": {"action": "NONE",
"assignments": ["string"
],
"filter": ["string"
],
"sourceAttributeName": "string"
},
"profileMaster": true
},
"subject": {"filter": "string",
"format": ["string"
],
"matchAttribute": "string",
"matchType": "USERNAME",
"userNameTemplate": {"template": "string"
}
}
},
"protocol": {"algorithms": {"request": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
},
"response": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
}
},
"credentials": {"client": {"client_id": "string",
"client_secret": "string"
},
"signing": {"kid": "string"
},
"trust": {"audience": "string",
"issuer": "string",
"kid": "string",
"revocation": "CRL",
"revocationCacheLifetime": 0
}
},
"endpoints": {"acs": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"authorization": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"jwks": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"metadata": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"slo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"sso": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"token": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"userInfo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
}
},
"issuer": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"relayState": {"format": "OPAQUE"
},
"scopes": ["string"
],
"settings": {"nameFormat": "string"
},
"type": "SAML2"
},
"status": "ACTIVE",
"type": "string"
}

List Keys

Enumerates IdP key credentials.

Authorizations:

api_token

query Parameters

after	string Specifies the pagination cursor for the next page of keys
limit	integer <int32> Default: 20 Specifies the number of key results in a page

Responses

Response Schema: application/json

Array ()

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}
]

Add X.509 Certificate Public Key

Adds a new X.509 certificate credential to the IdP key store.

Authorizations:

api_token

Request Body schema: application/json

alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Responses

Response Schema: application/json

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Request samples

Content type

application/json

{"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}

Get Key

Gets a specific IdP Key Credential by kid

Authorizations:

api_token

path Parameters

keyId

required

string

Responses

Response Schema: application/json

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}

Delete Key

Deletes a specific IdP Key Credential by kid if it is not currently being used by an Active or Inactive IdP.

Authorizations:

api_token

path Parameters

keyId

required

string

Responses

Get Identity Provider

Fetches an IdP by id.

Authorizations:

api_token

path Parameters

idpId

required

string

Responses

Response Schema: application/json

	object
created	string <date-time>
id	string
issuerMode	string Enum: "ORG_URL" "CUSTOM_URL_DOMAIN"
lastUpdated	string <date-time>
name	string
	object (IdentityProviderPolicy)
	object (Protocol)
status	string Enum: "ACTIVE" "INACTIVE"
type	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"issuerMode": "ORG_URL",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"policy": {"accountLink": {"action": "AUTO",
"filter": {"groups": {"include": ["string"
]
}
}
},
"maxClockSkew": 0,
"provisioning": {"action": "AUTO",
"conditions": {"deprovisioned": {"action": "NONE"
},
"suspended": {"action": "NONE"
}
},
"groups": {"action": "NONE",
"assignments": ["string"
],
"filter": ["string"
],
"sourceAttributeName": "string"
},
"profileMaster": true
},
"subject": {"filter": "string",
"format": ["string"
],
"matchAttribute": "string",
"matchType": "USERNAME",
"userNameTemplate": {"template": "string"
}
}
},
"protocol": {"algorithms": {"request": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
},
"response": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
}
},
"credentials": {"client": {"client_id": "string",
"client_secret": "string"
},
"signing": {"kid": "string"
},
"trust": {"audience": "string",
"issuer": "string",
"kid": "string",
"revocation": "CRL",
"revocationCacheLifetime": 0
}
},
"endpoints": {"acs": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"authorization": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"jwks": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"metadata": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"slo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"sso": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"token": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"userInfo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
}
},
"issuer": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"relayState": {"format": "OPAQUE"
},
"scopes": ["string"
],
"settings": {"nameFormat": "string"
},
"type": "SAML2"
},
"status": "ACTIVE",
"type": "string"
}

Update Identity Provider

Updates the configuration for an IdP.

Authorizations:

api_token

path Parameters

idpId

required

string

Request Body schema: application/json

issuerMode	string Enum: "ORG_URL" "CUSTOM_URL_DOMAIN"
name	string
	object (IdentityProviderPolicy)
	object (Protocol)
status	string Enum: "ACTIVE" "INACTIVE"
type	string

Responses

Response Schema: application/json

	object
created	string <date-time>
id	string
issuerMode	string Enum: "ORG_URL" "CUSTOM_URL_DOMAIN"
lastUpdated	string <date-time>
name	string
	object (IdentityProviderPolicy)
	object (Protocol)
status	string Enum: "ACTIVE" "INACTIVE"
type	string

Request samples

Content type

application/json

{"issuerMode": "ORG_URL",
"name": "string",
"policy": {"accountLink": {"action": "AUTO",
"filter": {"groups": {"include": ["string"
]
}
}
},
"maxClockSkew": 0,
"provisioning": {"action": "AUTO",
"conditions": {"deprovisioned": {"action": "NONE"
},
"suspended": {"action": "NONE"
}
},
"groups": {"action": "NONE",
"assignments": ["string"
],
"filter": ["string"
],
"sourceAttributeName": "string"
},
"profileMaster": true
},
"subject": {"filter": "string",
"format": ["string"
],
"matchAttribute": "string",
"matchType": "USERNAME",
"userNameTemplate": {"template": "string"
}
}
},
"protocol": {"algorithms": {"request": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
},
"response": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
}
},
"credentials": {"client": {"client_id": "string",
"client_secret": "string"
},
"signing": {"kid": "string"
},
"trust": {"audience": "string",
"issuer": "string",
"kid": "string",
"revocation": "CRL",
"revocationCacheLifetime": 0
}
},
"endpoints": {"acs": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"authorization": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"jwks": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"metadata": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"slo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"sso": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"token": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"userInfo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
}
},
"issuer": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"relayState": {"format": "OPAQUE"
},
"scopes": ["string"
],
"settings": {"nameFormat": "string"
},
"type": "SAML2"
},
"status": "ACTIVE",
"type": "string"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"issuerMode": "ORG_URL",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"policy": {"accountLink": {"action": "AUTO",
"filter": {"groups": {"include": ["string"
]
}
}
},
"maxClockSkew": 0,
"provisioning": {"action": "AUTO",
"conditions": {"deprovisioned": {"action": "NONE"
},
"suspended": {"action": "NONE"
}
},
"groups": {"action": "NONE",
"assignments": ["string"
],
"filter": ["string"
],
"sourceAttributeName": "string"
},
"profileMaster": true
},
"subject": {"filter": "string",
"format": ["string"
],
"matchAttribute": "string",
"matchType": "USERNAME",
"userNameTemplate": {"template": "string"
}
}
},
"protocol": {"algorithms": {"request": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
},
"response": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
}
},
"credentials": {"client": {"client_id": "string",
"client_secret": "string"
},
"signing": {"kid": "string"
},
"trust": {"audience": "string",
"issuer": "string",
"kid": "string",
"revocation": "CRL",
"revocationCacheLifetime": 0
}
},
"endpoints": {"acs": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"authorization": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"jwks": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"metadata": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"slo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"sso": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"token": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"userInfo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
}
},
"issuer": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"relayState": {"format": "OPAQUE"
},
"scopes": ["string"
],
"settings": {"nameFormat": "string"
},
"type": "SAML2"
},
"status": "ACTIVE",
"type": "string"
}

Delete Identity Provider

Removes an IdP from your organization.

Authorizations:

api_token

path Parameters

idpId

required

string

Responses

List Certificate Signing Requests for IdP

Enumerates Certificate Signing Requests for an IdP

Authorizations:

api_token

path Parameters

idpId

required

string

Responses

Response Schema: application/json

Array ()

created	string <date-time>
csr	string
id	string
kty	string

Response samples

200

Content type

application/json

[{"created": "2019-08-24T14:15:22Z",
"csr": "string",
"id": "string",
"kty": "string"
}
]

Generate Certificate Signing Request for IdP

Generates a new key pair and returns a Certificate Signing Request for it.

Authorizations:

api_token

path Parameters

idpId

required

string

Request Body schema: application/json

	object (CsrMetadataSubject)
	object (CsrMetadataSubjectAltNames)

Responses

Response Schema: application/json

created	string <date-time>
csr	string
id	string
kty	string

Request samples

Content type

application/json

{"subject": {"commonName": "string",
"countryName": "string",
"localityName": "string",
"organizationName": "string",
"organizationalUnitName": "string",
"stateOrProvinceName": "string"
},
"subjectAltNames": {"dnsNames": ["string"
]
}
}

Response samples

201

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"csr": "string",
"id": "string",
"kty": "string"
}

getCsrForIdentityProvider

Gets a specific Certificate Signing Request model by id

Authorizations:

api_token

path Parameters

csrId required	string
idpId required	string

Responses

Response Schema: application/json

created	string <date-time>
csr	string
id	string
kty	string

Response samples

200

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"csr": "string",
"id": "string",
"kty": "string"
}

revokeCsrForIdentityProvider

Revoke a Certificate Signing Request and delete the key pair from the IdP

Authorizations:

api_token

path Parameters

csrId required	string
idpId required	string

Responses

publishCsrForIdentityProvider

Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.

Authorizations:

api_token

path Parameters

csrId required	string
idpId required	string

Request Body schema:
application/octet-stream
application/octet-stream
application/x-x509-ca-cert
application/pkix-cert
application/x-pem-file

string <binary>

Responses

Response Schema: application/json

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Response samples

201

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}

List Signing Key Credentials for IdP

Enumerates signing key credentials for an IdP

Authorizations:

api_token

path Parameters

idpId

required

string

Responses

Response Schema: application/json

Array ()

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}
]

Generate New IdP Signing Key Credential

Generates a new X.509 certificate for an IdP signing key credential to be used for signing assertions sent to the IdP

Authorizations:

api_token

path Parameters

idpId

required

string

query Parameters

validityYears

required

integer <int32>

expiry of the IdP Key Credential

Responses

Response Schema: application/json

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}

Get Signing Key Credential for IdP

Gets a specific IdP Key Credential by kid

Authorizations:

api_token

path Parameters

idpId required	string
keyId required	string

Responses

Response Schema: application/json

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}

Clone Signing Key Credential for IdP

Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP

Authorizations:

api_token

path Parameters

idpId required	string
keyId required	string

query Parameters

targetIdpId

required

string

Responses

Response Schema: application/json

	object
alg	string
created	string <date-time>
e	string
expiresAt	string <date-time>
key_ops	Array of strings
kid	string
kty	string
lastUpdated	string <date-time>
n	string
status	string
use	string
x5c	Array of strings
x5t	string
x5t#S256	string
x5u	string

Response samples

201

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"alg": "string",
"created": "2019-08-24T14:15:22Z",
"e": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"key_ops": ["string"
],
"kid": "string",
"kty": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"n": "string",
"status": "string",
"use": "string",
"x5c": ["string"
],
"x5t": "string",
"x5t#S256": "string",
"x5u": "string"
}

Activate Identity Provider

Activates an inactive IdP.

Authorizations:

api_token

path Parameters

idpId

required

string

Responses

Response Schema: application/json

	object
created	string <date-time>
id	string
issuerMode	string Enum: "ORG_URL" "CUSTOM_URL_DOMAIN"
lastUpdated	string <date-time>
name	string
	object (IdentityProviderPolicy)
	object (Protocol)
status	string Enum: "ACTIVE" "INACTIVE"
type	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"issuerMode": "ORG_URL",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"policy": {"accountLink": {"action": "AUTO",
"filter": {"groups": {"include": ["string"
]
}
}
},
"maxClockSkew": 0,
"provisioning": {"action": "AUTO",
"conditions": {"deprovisioned": {"action": "NONE"
},
"suspended": {"action": "NONE"
}
},
"groups": {"action": "NONE",
"assignments": ["string"
],
"filter": ["string"
],
"sourceAttributeName": "string"
},
"profileMaster": true
},
"subject": {"filter": "string",
"format": ["string"
],
"matchAttribute": "string",
"matchType": "USERNAME",
"userNameTemplate": {"template": "string"
}
}
},
"protocol": {"algorithms": {"request": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
},
"response": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
}
},
"credentials": {"client": {"client_id": "string",
"client_secret": "string"
},
"signing": {"kid": "string"
},
"trust": {"audience": "string",
"issuer": "string",
"kid": "string",
"revocation": "CRL",
"revocationCacheLifetime": 0
}
},
"endpoints": {"acs": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"authorization": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"jwks": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"metadata": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"slo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"sso": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"token": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"userInfo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
}
},
"issuer": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"relayState": {"format": "OPAQUE"
},
"scopes": ["string"
],
"settings": {"nameFormat": "string"
},
"type": "SAML2"
},
"status": "ACTIVE",
"type": "string"
}

Deactivate Identity Provider

Deactivates an active IdP.

Authorizations:

api_token

path Parameters

idpId

required

string

Responses

Response Schema: application/json

	object
created	string <date-time>
id	string
issuerMode	string Enum: "ORG_URL" "CUSTOM_URL_DOMAIN"
lastUpdated	string <date-time>
name	string
	object (IdentityProviderPolicy)
	object (Protocol)
status	string Enum: "ACTIVE" "INACTIVE"
type	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"issuerMode": "ORG_URL",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"policy": {"accountLink": {"action": "AUTO",
"filter": {"groups": {"include": ["string"
]
}
}
},
"maxClockSkew": 0,
"provisioning": {"action": "AUTO",
"conditions": {"deprovisioned": {"action": "NONE"
},
"suspended": {"action": "NONE"
}
},
"groups": {"action": "NONE",
"assignments": ["string"
],
"filter": ["string"
],
"sourceAttributeName": "string"
},
"profileMaster": true
},
"subject": {"filter": "string",
"format": ["string"
],
"matchAttribute": "string",
"matchType": "USERNAME",
"userNameTemplate": {"template": "string"
}
}
},
"protocol": {"algorithms": {"request": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
},
"response": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
}
},
"credentials": {"client": {"client_id": "string",
"client_secret": "string"
},
"signing": {"kid": "string"
},
"trust": {"audience": "string",
"issuer": "string",
"kid": "string",
"revocation": "CRL",
"revocationCacheLifetime": 0
}
},
"endpoints": {"acs": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"authorization": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"jwks": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"metadata": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"slo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"sso": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"token": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"userInfo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
}
},
"issuer": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"relayState": {"format": "OPAQUE"
},
"scopes": ["string"
],
"settings": {"nameFormat": "string"
},
"type": "SAML2"
},
"status": "ACTIVE",
"type": "string"
}

Find Users

Find all the users linked to an identity provider

Authorizations:

api_token

path Parameters

idpId

required

string

Responses

Response Schema: application/json

Array ()

	object
	object
created	string
externalId	string
id	string
lastUpdated	string
	object

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "string",
"externalId": "string",
"id": "string",
"lastUpdated": "string",
"profile": {"property1": { },
"property2": { }
}
}
]

getIdentityProviderApplicationUser

Fetches a linked IdP user by ID

Authorizations:

api_token

path Parameters

idpId required	string
userId required	string

Responses

Response Schema: application/json

	object
	object
created	string
externalId	string
id	string
lastUpdated	string
	object

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "string",
"externalId": "string",
"id": "string",
"lastUpdated": "string",
"profile": {"property1": { },
"property2": { }
}
}

Link a user to a Social IdP without a transaction

Links an Okta user to an existing Social Identity Provider. This does not support the SAML2 Identity Provider Type

Authorizations:

api_token

path Parameters

idpId required	string
userId required	string

Request Body schema: application/json

externalId

string

Responses

Response Schema: application/json

	object
	object
created	string
externalId	string
id	string
lastUpdated	string
	object

Request samples

Content type

application/json

{"externalId": "string"
}

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "string",
"externalId": "string",
"id": "string",
"lastUpdated": "string",
"profile": {"property1": { },
"property2": { }
}
}

Unlink User from IdP

Removes the link between the Okta user and the IdP user.

Authorizations:

api_token

path Parameters

idpId required	string
userId required	string

Responses

Social Authentication Token Operation

Fetches the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth.

Authorizations:

api_token

path Parameters

idpId required	string
userId required	string

Responses

Response Schema: application/json

Array ()

expiresAt	string <date-time>
id	string
scopes	Array of strings
token	string
tokenAuthScheme	string
tokenType	string Enum: "ACCESS" "REFRESH"

Response samples

200

Content type

application/json

[{"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"scopes": ["string"
],
"token": "string",
"tokenAuthScheme": "string",
"tokenType": "ACCESS"
}
]

InlineHook

listInlineHooks

Success

Authorizations:

api_token

query Parameters

type

string

Responses

Response Schema: application/json

Array ()

	object
	object (InlineHookChannel)
created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
status	string (InlineHookStatus) Enum: "ACTIVE" "INACTIVE"
type	string (InlineHookType) Enum: "com.okta.oauth2.tokens.transform" "com.okta.import.transform" "com.okta.saml.tokens.transform" "com.okta.user.pre-registration" "com.okta.user.credential.password.import"
version	string

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"channel": {"config": {"authScheme": {"key": "string",
"type": "string",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string",
"method": "string"
},
"type": "HTTP",
"version": "string"
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"type": "com.okta.oauth2.tokens.transform",
"version": "string"
}
]

createInlineHook

Success

Authorizations:

api_token

Request Body schema: application/json

	object (InlineHookChannel)
name	string
status	string (InlineHookStatus) Enum: "ACTIVE" "INACTIVE"
type	string (InlineHookType) Enum: "com.okta.oauth2.tokens.transform" "com.okta.import.transform" "com.okta.saml.tokens.transform" "com.okta.user.pre-registration" "com.okta.user.credential.password.import"
version	string

Responses

Response Schema: application/json

	object
	object (InlineHookChannel)
created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
status	string (InlineHookStatus) Enum: "ACTIVE" "INACTIVE"
type	string (InlineHookType) Enum: "com.okta.oauth2.tokens.transform" "com.okta.import.transform" "com.okta.saml.tokens.transform" "com.okta.user.pre-registration" "com.okta.user.credential.password.import"
version	string

Request samples

Content type

application/json

{"channel": {"config": {"authScheme": {"key": "string",
"type": "string",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string",
"method": "string"
},
"type": "HTTP",
"version": "string"
},
"name": "string",
"status": "ACTIVE",
"type": "com.okta.oauth2.tokens.transform",
"version": "string"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"channel": {"config": {"authScheme": {"key": "string",
"type": "string",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string",
"method": "string"
},
"type": "HTTP",
"version": "string"
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"type": "com.okta.oauth2.tokens.transform",
"version": "string"
}

getInlineHook

Gets an inline hook by ID

Authorizations:

api_token

path Parameters

inlineHookId

required

string

Responses

Response Schema: application/json

	object
	object (InlineHookChannel)
created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
status	string (InlineHookStatus) Enum: "ACTIVE" "INACTIVE"
type	string (InlineHookType) Enum: "com.okta.oauth2.tokens.transform" "com.okta.import.transform" "com.okta.saml.tokens.transform" "com.okta.user.pre-registration" "com.okta.user.credential.password.import"
version	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"channel": {"config": {"authScheme": {"key": "string",
"type": "string",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string",
"method": "string"
},
"type": "HTTP",
"version": "string"
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"type": "com.okta.oauth2.tokens.transform",
"version": "string"
}

updateInlineHook

Updates an inline hook by ID

Authorizations:

api_token

path Parameters

inlineHookId

required

string

Request Body schema: application/json

	object (InlineHookChannel)
name	string
status	string (InlineHookStatus) Enum: "ACTIVE" "INACTIVE"
type	string (InlineHookType) Enum: "com.okta.oauth2.tokens.transform" "com.okta.import.transform" "com.okta.saml.tokens.transform" "com.okta.user.pre-registration" "com.okta.user.credential.password.import"
version	string

Responses

Response Schema: application/json

	object
	object (InlineHookChannel)
created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
status	string (InlineHookStatus) Enum: "ACTIVE" "INACTIVE"
type	string (InlineHookType) Enum: "com.okta.oauth2.tokens.transform" "com.okta.import.transform" "com.okta.saml.tokens.transform" "com.okta.user.pre-registration" "com.okta.user.credential.password.import"
version	string

Request samples

Content type

application/json

{"channel": {"config": {"authScheme": {"key": "string",
"type": "string",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string",
"method": "string"
},
"type": "HTTP",
"version": "string"
},
"name": "string",
"status": "ACTIVE",
"type": "com.okta.oauth2.tokens.transform",
"version": "string"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"channel": {"config": {"authScheme": {"key": "string",
"type": "string",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string",
"method": "string"
},
"type": "HTTP",
"version": "string"
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"type": "com.okta.oauth2.tokens.transform",
"version": "string"
}

deleteInlineHook

Deletes the Inline Hook matching the provided id. Once deleted, the Inline Hook is unrecoverable. As a safety precaution, only Inline Hooks with a status of INACTIVE are eligible for deletion.

Authorizations:

api_token

path Parameters

inlineHookId

required

string

Responses

executeInlineHook

Executes the Inline Hook matching the provided inlineHookId using the request body as the input. This will send the provided data through the Channel and return a response if it matches the correct data contract. This execution endpoint should only be used for testing purposes.

Authorizations:

api_token

path Parameters

inlineHookId

required

string

Request Body schema: application/json

object (InlineHookPayload)

Responses

Response Schema: application/json

Array of objects (InlineHookResponseCommands)

Request samples

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"commands": [{"type": "string",
"value": [{"op": "string",
"path": "string",
"value": "string"
}
]
}
]
}

activateInlineHook

Activates the Inline Hook matching the provided id

path Parameters

inlineHookId

required

string

Responses

Response Schema: application/json

	object
	object (InlineHookChannel)
created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
status	string (InlineHookStatus) Enum: "ACTIVE" "INACTIVE"
type	string (InlineHookType) Enum: "com.okta.oauth2.tokens.transform" "com.okta.import.transform" "com.okta.saml.tokens.transform" "com.okta.user.pre-registration" "com.okta.user.credential.password.import"
version	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"channel": {"config": {"authScheme": {"key": "string",
"type": "string",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string",
"method": "string"
},
"type": "HTTP",
"version": "string"
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"type": "com.okta.oauth2.tokens.transform",
"version": "string"
}

deactivateInlineHook

Deactivates the Inline Hook matching the provided id

path Parameters

inlineHookId

required

string

Responses

Response Schema: application/json

	object
	object (InlineHookChannel)
created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
status	string (InlineHookStatus) Enum: "ACTIVE" "INACTIVE"
type	string (InlineHookType) Enum: "com.okta.oauth2.tokens.transform" "com.okta.import.transform" "com.okta.saml.tokens.transform" "com.okta.user.pre-registration" "com.okta.user.credential.password.import"
version	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"channel": {"config": {"authScheme": {"key": "string",
"type": "string",
"value": "string"
},
"headers": [{"key": "string",
"value": "string"
}
],
"uri": "string",
"method": "string"
},
"type": "HTTP",
"version": "string"
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"status": "ACTIVE",
"type": "com.okta.oauth2.tokens.transform",
"version": "string"
}

Ion

LinkedObject

listLinkedObjectDefinitions

Success

Authorizations:

api_token

Responses

Response Schema: application/json

Array ()

	object
	object (LinkedObjectDetails)
	object (LinkedObjectDetails)

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"associated": {"description": "string",
"name": "string",
"title": "string",
"type": "USER"
},
"primary": {"description": "string",
"name": "string",
"title": "string",
"type": "USER"
}
}
]

addLinkedObjectDefinition

Success

Authorizations:

api_token

Request Body schema: application/json

	object (LinkedObjectDetails)
	object (LinkedObjectDetails)

Responses

Response Schema: application/json

	object
	object (LinkedObjectDetails)
	object (LinkedObjectDetails)

Request samples

Content type

application/json

{"associated": {"description": "string",
"name": "string",
"title": "string",
"type": "USER"
},
"primary": {"description": "string",
"name": "string",
"title": "string",
"type": "USER"
}
}

Response samples

201

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"associated": {"description": "string",
"name": "string",
"title": "string",
"type": "USER"
},
"primary": {"description": "string",
"name": "string",
"title": "string",
"type": "USER"
}
}

getLinkedObjectDefinition

Success

Authorizations:

api_token

path Parameters

linkedObjectName

required

string

Responses

Response Schema: application/json

	object
	object (LinkedObjectDetails)
	object (LinkedObjectDetails)

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"associated": {"description": "string",
"name": "string",
"title": "string",
"type": "USER"
},
"primary": {"description": "string",
"name": "string",
"title": "string",
"type": "USER"
}
}

deleteLinkedObjectDefinition

Success

Authorizations:

api_token

path Parameters

linkedObjectName

required

string

Responses

Log

Fetch a list of events from your Okta organization system log.

The Okta System Log API provides read access to your organization’s system log. This API provides more functionality than the Events API

Authorizations:

api_token

query Parameters

after	string
filter	string
limit	integer Default: 100
q	string
since	string <date-time>
sortOrder	string Default: "ASCENDING"
until	string <date-time>

Responses

Response Schema: application/json

Array ()

	object (LogActor)
	object (LogAuthenticationContext)
	object (LogClient)
	object (LogDebugContext)
displayMessage	string
eventType	string
legacyEventType	string
	object (LogOutcome)
published	string <date-time>
	object (LogRequest)
	object (LogSecurityContext)
severity	string (LogSeverity) Enum: "DEBUG" "INFO" "WARN" "ERROR"
	Array of objects (LogTarget)
	object (LogTransaction)
uuid	string
version	string

Response samples

200

Content type

application/json

[{"actor": {"alternateId": "string",
"detail": {"property1": { },
"property2": { }
},
"displayName": "string",
"id": "string",
"type": "string"
},
"authenticationContext": {"authenticationProvider": "OKTA_AUTHENTICATION_PROVIDER",
"authenticationStep": 0,
"credentialProvider": "OKTA_AUTHENTICATION_PROVIDER",
"credentialType": "OTP",
"externalSessionId": "string",
"interface": "string",
"issuer": {"id": "string",
"type": "string"
}
},
"client": {"device": "string",
"geographicalContext": {"city": "string",
"country": "string",
"geolocation": {"lat": 0,
"lon": 0
},
"postalCode": "string",
"state": "string"
},
"id": "string",
"ipAddress": "string",
"userAgent": {"browser": "string",
"os": "string",
"rawUserAgent": "string"
},
"zone": "string"
},
"debugContext": {"debugData": {"property1": { },
"property2": { }
}
},
"displayMessage": "string",
"eventType": "string",
"legacyEventType": "string",
"outcome": {"reason": "string",
"result": "string"
},
"published": "2019-08-24T14:15:22Z",
"request": {"ipChain": [{"geographicalContext": {"city": "string",
"country": "string",
"geolocation": {"lat": 0,
"lon": 0
},
"postalCode": "string",
"state": "string"
},
"ip": "string",
"source": "string",
"version": "string"
}
]
},
"securityContext": {"asNumber": 0,
"asOrg": "string",
"domain": "string",
"isProxy": true,
"isp": "string"
},
"severity": "DEBUG",
"target": [{"alternateId": "string",
"detailEntry": {"property1": { },
"property2": { }
},
"displayName": "string",
"id": "string",
"type": "string"
}
],
"transaction": {"detail": {"property1": { },
"property2": { }
},
"id": "string",
"type": "string"
},
"uuid": "string",
"version": "string"
}
]

NetworkZone

List Network Zones

Enumerates network zones added to your organization with pagination. A subset of zones can be returned that match a supported filter expression or query.

Authorizations:

api_token

query Parameters

after	string Specifies the pagination cursor for the next page of network zones
filter	string Filters zones by usage or id expression
limit	integer <int32> Default: -1 Specifies the number of results for a page

Responses

Response Schema: application/json

Array ()

	object
asns	Array of strings
created	string <date-time>
	Array of objects (NetworkZoneAddress)
id	string
lastUpdated	string <date-time>
	Array of objects (NetworkZoneLocation)
name	string
	Array of objects (NetworkZoneAddress)
proxyType	string
status	string (NetworkZoneStatus) Enum: "ACTIVE" "INACTIVE"
system	boolean
type	string (NetworkZoneType) Enum: "IP" "DYNAMIC"
usage	string (NetworkZoneUsage) Enum: "POLICY" "BLOCKLIST"

Response samples

200

Content type

application/json

[{"type": "IP",
"id": "string",
"name": "string",
"system": true,
"usage": "POLICY",
"status": "ACTIVE",
"proxyType": "string",
"locations": [{"country": "string",
"region": "string"
}
],
"gateways": [{"type": "CIDR",
"value": "string"
}
],
"proxies": [{"type": "CIDR",
"value": "string"
}
],
"asns": ["string"
],
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"_links": {"property1": { },
"property2": { }
}
}
]

Add Network Zone

Adds a new network zone to your Okta organization.

Authorizations:

api_token

Request Body schema: application/json

asns	Array of strings
	Array of objects (NetworkZoneAddress)
	Array of objects (NetworkZoneLocation)
name	string
	Array of objects (NetworkZoneAddress)
proxyType	string
status	string (NetworkZoneStatus) Enum: "ACTIVE" "INACTIVE"
system	boolean
type	string (NetworkZoneType) Enum: "IP" "DYNAMIC"
usage	string (NetworkZoneUsage) Enum: "POLICY" "BLOCKLIST"

Responses

Response Schema: application/json

	object
asns	Array of strings
created	string <date-time>
	Array of objects (NetworkZoneAddress)
id	string
lastUpdated	string <date-time>
	Array of objects (NetworkZoneLocation)
name	string
	Array of objects (NetworkZoneAddress)
proxyType	string
status	string (NetworkZoneStatus) Enum: "ACTIVE" "INACTIVE"
system	boolean
type	string (NetworkZoneType) Enum: "IP" "DYNAMIC"
usage	string (NetworkZoneUsage) Enum: "POLICY" "BLOCKLIST"

Request samples

Content type

application/json

{"type": "IP",
"name": "string",
"system": true,
"usage": "POLICY",
"status": "ACTIVE",
"proxyType": "string",
"locations": [{"country": "string",
"region": "string"
}
],
"gateways": [{"type": "CIDR",
"value": "string"
}
],
"proxies": [{"type": "CIDR",
"value": "string"
}
],
"asns": ["string"
]
}

Response samples

200

Content type

application/json

{"type": "IP",
"id": "string",
"name": "string",
"system": true,
"usage": "POLICY",
"status": "ACTIVE",
"proxyType": "string",
"locations": [{"country": "string",
"region": "string"
}
],
"gateways": [{"type": "CIDR",
"value": "string"
}
],
"proxies": [{"type": "CIDR",
"value": "string"
}
],
"asns": ["string"
],
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"_links": {"property1": { },
"property2": { }
}
}

Get Network Zone

Fetches a network zone from your Okta organization by id.

Authorizations:

api_token

path Parameters

zoneId

required

string

Responses

Response Schema: application/json

	object
asns	Array of strings
created	string <date-time>
	Array of objects (NetworkZoneAddress)
id	string
lastUpdated	string <date-time>
	Array of objects (NetworkZoneLocation)
name	string
	Array of objects (NetworkZoneAddress)
proxyType	string
status	string (NetworkZoneStatus) Enum: "ACTIVE" "INACTIVE"
system	boolean
type	string (NetworkZoneType) Enum: "IP" "DYNAMIC"
usage	string (NetworkZoneUsage) Enum: "POLICY" "BLOCKLIST"

Response samples

200

Content type

application/json

{"type": "IP",
"id": "string",
"name": "string",
"system": true,
"usage": "POLICY",
"status": "ACTIVE",
"proxyType": "string",
"locations": [{"country": "string",
"region": "string"
}
],
"gateways": [{"type": "CIDR",
"value": "string"
}
],
"proxies": [{"type": "CIDR",
"value": "string"
}
],
"asns": ["string"
],
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"_links": {"property1": { },
"property2": { }
}
}

Update Network Zone

Updates a network zone in your organization.

Authorizations:

api_token

path Parameters

zoneId

required

string

Request Body schema: application/json

asns	Array of strings
	Array of objects (NetworkZoneAddress)
	Array of objects (NetworkZoneLocation)
name	string
	Array of objects (NetworkZoneAddress)
proxyType	string
status	string (NetworkZoneStatus) Enum: "ACTIVE" "INACTIVE"
system	boolean
type	string (NetworkZoneType) Enum: "IP" "DYNAMIC"
usage	string (NetworkZoneUsage) Enum: "POLICY" "BLOCKLIST"

Responses

Response Schema: application/json

	object
asns	Array of strings
created	string <date-time>
	Array of objects (NetworkZoneAddress)
id	string
lastUpdated	string <date-time>
	Array of objects (NetworkZoneLocation)
name	string
	Array of objects (NetworkZoneAddress)
proxyType	string
status	string (NetworkZoneStatus) Enum: "ACTIVE" "INACTIVE"
system	boolean
type	string (NetworkZoneType) Enum: "IP" "DYNAMIC"
usage	string (NetworkZoneUsage) Enum: "POLICY" "BLOCKLIST"

Request samples

Content type

application/json

{"type": "IP",
"name": "string",
"system": true,
"usage": "POLICY",
"status": "ACTIVE",
"proxyType": "string",
"locations": [{"country": "string",
"region": "string"
}
],
"gateways": [{"type": "CIDR",
"value": "string"
}
],
"proxies": [{"type": "CIDR",
"value": "string"
}
],
"asns": ["string"
]
}

Response samples

200

Content type

application/json

{"type": "IP",
"id": "string",
"name": "string",
"system": true,
"usage": "POLICY",
"status": "ACTIVE",
"proxyType": "string",
"locations": [{"country": "string",
"region": "string"
}
],
"gateways": [{"type": "CIDR",
"value": "string"
}
],
"proxies": [{"type": "CIDR",
"value": "string"
}
],
"asns": ["string"
],
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"_links": {"property1": { },
"property2": { }
}
}

Delete Network Zone

Removes network zone.

Authorizations:

api_token

path Parameters

zoneId

required

string

Responses

Deactivate Network Zone

Deactivates a network zone.

Authorizations:

api_token

path Parameters

zoneId

required

string

Responses

Response Schema: application/json

	object
asns	Array of strings
created	string <date-time>
	Array of objects (NetworkZoneAddress)
id	string
lastUpdated	string <date-time>
	Array of objects (NetworkZoneLocation)
name	string
	Array of objects (NetworkZoneAddress)
proxyType	string
status	string (NetworkZoneStatus) Enum: "ACTIVE" "INACTIVE"
system	boolean
type	string (NetworkZoneType) Enum: "IP" "DYNAMIC"
usage	string (NetworkZoneUsage) Enum: "POLICY" "BLOCKLIST"

Response samples

200

Content type

application/json

{"type": "IP",
"id": "string",
"name": "string",
"system": true,
"usage": "POLICY",
"status": "ACTIVE",
"proxyType": "string",
"locations": [{"country": "string",
"region": "string"
}
],
"gateways": [{"type": "CIDR",
"value": "string"
}
],
"proxies": [{"type": "CIDR",
"value": "string"
}
],
"asns": ["string"
],
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"_links": {"property1": { },
"property2": { }
}
}

Activate Network Zone

Authorizations:

api_token

path Parameters

zoneId

required

string

Responses

Response Schema: application/json

	object
asns	Array of strings
created	string <date-time>
	Array of objects (NetworkZoneAddress)
id	string
lastUpdated	string <date-time>
	Array of objects (NetworkZoneLocation)
name	string
	Array of objects (NetworkZoneAddress)
proxyType	string
status	string (NetworkZoneStatus) Enum: "ACTIVE" "INACTIVE"
system	boolean
type	string (NetworkZoneType) Enum: "IP" "DYNAMIC"
usage	string (NetworkZoneUsage) Enum: "POLICY" "BLOCKLIST"

Response samples

200

Content type

application/json

{"type": "IP",
"id": "string",
"name": "string",
"system": true,
"usage": "POLICY",
"status": "ACTIVE",
"proxyType": "string",
"locations": [{"country": "string",
"region": "string"
}
],
"gateways": [{"type": "CIDR",
"value": "string"
}
],
"proxies": [{"type": "CIDR",
"value": "string"
}
],
"asns": ["string"
],
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"_links": {"property1": { },
"property2": { }
}
}

Org

Get org settings

Get settings of your organization.

Authorizations:

api_token

Responses

Response Schema: application/json

	object
address1	string
address2	string
city	string
companyName	string
country	string
created	string <date-time>
endUserSupportHelpURL	string
expiresAt	string <date-time>
id	string
lastUpdated	string <date-time>
phoneNumber	string
postalCode	string
state	string
status	string
subdomain	string
supportPhoneNumber	string
website	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"address1": "string",
"address2": "string",
"city": "string",
"companyName": "string",
"country": "string",
"created": "2019-08-24T14:15:22Z",
"endUserSupportHelpURL": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"status": "string",
"subdomain": "string",
"supportPhoneNumber": "string",
"website": "string"
}

Partial update Org Setting

Partial update settings of your organization.

Authorizations:

api_token

Request Body schema: application/json

	object
address1	string
address2	string
city	string
companyName	string
country	string
endUserSupportHelpURL	string
phoneNumber	string
postalCode	string
state	string
supportPhoneNumber	string
website	string

Responses

Response Schema: application/json

	object
address1	string
address2	string
city	string
companyName	string
country	string
created	string <date-time>
endUserSupportHelpURL	string
expiresAt	string <date-time>
id	string
lastUpdated	string <date-time>
phoneNumber	string
postalCode	string
state	string
status	string
subdomain	string
supportPhoneNumber	string
website	string

Request samples

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"address1": "string",
"address2": "string",
"city": "string",
"companyName": "string",
"country": "string",
"endUserSupportHelpURL": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"supportPhoneNumber": "string",
"website": "string"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"address1": "string",
"address2": "string",
"city": "string",
"companyName": "string",
"country": "string",
"created": "2019-08-24T14:15:22Z",
"endUserSupportHelpURL": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"status": "string",
"subdomain": "string",
"supportPhoneNumber": "string",
"website": "string"
}

Update Org setting

Update settings of your organization.

Authorizations:

api_token

Request Body schema: application/json

	object
address1	string
address2	string
city	string
companyName	string
country	string
endUserSupportHelpURL	string
phoneNumber	string
postalCode	string
state	string
supportPhoneNumber	string
website	string

Responses

Response Schema: application/json

	object
address1	string
address2	string
city	string
companyName	string
country	string
created	string <date-time>
endUserSupportHelpURL	string
expiresAt	string <date-time>
id	string
lastUpdated	string <date-time>
phoneNumber	string
postalCode	string
state	string
status	string
subdomain	string
supportPhoneNumber	string
website	string

Request samples

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"address1": "string",
"address2": "string",
"city": "string",
"companyName": "string",
"country": "string",
"endUserSupportHelpURL": "string",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"supportPhoneNumber": "string",
"website": "string"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"address1": "string",
"address2": "string",
"city": "string",
"companyName": "string",
"country": "string",
"created": "2019-08-24T14:15:22Z",
"endUserSupportHelpURL": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"phoneNumber": "string",
"postalCode": "string",
"state": "string",
"status": "string",
"subdomain": "string",
"supportPhoneNumber": "string",
"website": "string"
}

Get org contact types

Gets Contact Types of your organization.

Authorizations:

api_token

Responses

Response Schema: application/json

Array ()

	object
contactType	string (OrgContactType) Enum: "BILLING" "TECHNICAL"

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"contactType": "BILLING"
}
]

Get org contact user

Retrieves the URL of the User associated with the specified Contact Type.

Authorizations:

api_token

path Parameters

contactType

required

string

Responses

Response Schema: application/json

	object
userId	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"userId": "string"
}

Update org contact user

Updates the User associated with the specified Contact Type.

Authorizations:

api_token

path Parameters

contactType

required

string

Request Body schema: application/json

userId

string

Responses

Response Schema: application/json

	object
userId	string

Request samples

Content type

application/json

{"userId": "string"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"userId": "string"
}

Get Okta Support settings

Gets Okta Support Settings of your organization.

Authorizations:

api_token

Responses

Response Schema: application/json

	object
expiration	string <date-time>
support	string (OrgOktaSupportSetting) Enum: "DISABLED" "ENABLED"

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"expiration": "2019-08-24T14:15:22Z",
"support": "DISABLED"
}

Grant Okta Support

Enables you to temporarily allow Okta Support to access your org as an administrator for eight hours.

Authorizations:

api_token

Responses

Response Schema: application/json

	object
expiration	string <date-time>
support	string (OrgOktaSupportSetting) Enum: "DISABLED" "ENABLED"

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"expiration": "2019-08-24T14:15:22Z",
"support": "DISABLED"
}

Extend Okta Support

Extends the length of time that Okta Support can access your org by 24 hours. This means that 24 hours are added to the remaining access time.

Authorizations:

api_token

Responses

Response Schema: application/json

	object
expiration	string <date-time>
support	string (OrgOktaSupportSetting) Enum: "DISABLED" "ENABLED"

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"expiration": "2019-08-24T14:15:22Z",
"support": "DISABLED"
}

Extend Okta Support

Revokes Okta Support access to your organization.

Authorizations:

api_token

Responses

Response Schema: application/json

	object
expiration	string <date-time>
support	string (OrgOktaSupportSetting) Enum: "DISABLED" "ENABLED"

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"expiration": "2019-08-24T14:15:22Z",
"support": "DISABLED"
}

Get Okta Communication Settings

Gets Okta Communication Settings of your organization.

Authorizations:

api_token

Responses

Response Schema: application/json

	object
optOutEmailUsers	boolean

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"optOutEmailUsers": true
}

Opt out all users from Okta Communication emails

Opts out all users of this org from Okta Communication emails.

Authorizations:

api_token

Responses

Response Schema: application/json

	object
optOutEmailUsers	boolean

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"optOutEmailUsers": true
}

Opt in all users to Okta Communication emails

Opts in all users of this org to Okta Communication emails.

Authorizations:

api_token

Responses

Response Schema: application/json

	object
optOutEmailUsers	boolean

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"optOutEmailUsers": true
}

Get org preferences

Gets preferences of your organization.

Authorizations:

api_token

Responses

Response Schema: application/json

	object
showEndUserFooter	boolean

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"showEndUserFooter": true
}

Show Okta UI Footer

Makes the Okta UI footer visible for all end users of your organization.

Authorizations:

api_token

Responses

Response Schema: application/json

	object
showEndUserFooter	boolean

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"showEndUserFooter": true
}

Show Okta UI Footer

Hide the Okta UI footer for all end users of your organization.

Authorizations:

api_token

Responses

Response Schema: application/json

	object
showEndUserFooter	boolean

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"showEndUserFooter": true
}

Policy

listPolicies

Gets all policies with the specified type.

Authorizations:

api_token

query Parameters

expand	string Default: ""
status	string
type required	string

Responses

Response Schema: application/json

Array ()

	object (PolicyAccountLink)
maxClockSkew	integer
	object (Provisioning)
	object (PolicySubject)

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"conditions": {"app": {"exclude": [{"id": "string",
"name": "string",
"type": "APP_TYPE"
}
],
"include": [{"id": "string",
"name": "string",
"type": "APP_TYPE"
}
]
},
"apps": {"exclude": ["string"
],
"include": ["string"
]
},
"authContext": {"authType": "ANY"
},
"authProvider": {"include": ["string"
],
"provider": "ACTIVE_DIRECTORY"
},
"beforeScheduledAction": {"duration": {"number": 0,
"unit": "string"
},
"lifecycleAction": {"status": "ACTIVE"
}
},
"clients": {"include": ["string"
]
},
"context": {"expression": "string"
},
"device": {"migrated": true,
"platform": {"supportedMDMFrameworks": ["AFW"
],
"types": ["IOS"
]
},
"rooted": true,
"trustLevel": "ANY"
},
"grantTypes": {"include": ["string"
]
},
"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"identityProvider": {"idpIds": ["string"
],
"provider": "ANY"
},
"mdmEnrollment": {"blockNonSafeAndroid": true,
"enrollment": "OMM"
},
"network": {"connection": "ANYWHERE",
"exclude": ["string"
],
"include": ["string"
]
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
},
"platform": {"exclude": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
],
"include": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
]
},
"risk": {"behaviors": ["string"
]
},
"riskScore": {"level": "string"
},
"scopes": {"include": ["string"
]
},
"userIdentifier": {"attribute": "string",
"patterns": [{"matchType": "SUFFIX",
"value": "string"
}
],
"type": "IDENTIFIER"
},
"userStatus": {"value": "ACTIVE"
},
"users": {"exclude": ["string"
],
"inactivity": {"number": 0,
"unit": "string"
},
"include": ["string"
],
"lifecycleExpiration": {"lifecycleStatus": "string",
"number": 0,
"unit": "string"
},
"passwordExpiration": {"number": 0,
"unit": "string"
},
"userLifecycleAttribute": {"attributeName": "string",
"matchingValue": "string"
}
}
},
"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"priority": 0,
"status": "ACTIVE",
"system": true,
"type": "OAUTH_AUTHORIZATION_POLICY"
}
]

createPolicy

Creates a policy.

Authorizations:

api_token

query Parameters

activate

boolean

Default: true

Request Body schema: application/json

	object (PolicyAccountLink)
maxClockSkew	integer
	object (Provisioning)
	object (PolicySubject)

Responses

Response Schema: application/json

	object (PolicyAccountLink)
maxClockSkew	integer
	object (Provisioning)
	object (PolicySubject)

Request samples

Content type

application/json

Example

{"accountLink": {"action": "AUTO",
"filter": {"groups": {"include": ["string"
]
}
}
},
"maxClockSkew": 0,
"provisioning": {"action": "AUTO",
"conditions": {"deprovisioned": {"action": "NONE"
},
"suspended": {"action": "NONE"
}
},
"groups": {"action": "NONE",
"assignments": ["string"
],
"filter": ["string"
],
"sourceAttributeName": "string"
},
"profileMaster": true
},
"subject": {"filter": "string",
"format": ["string"
],
"matchAttribute": "string",
"matchType": "USERNAME",
"userNameTemplate": {"template": "string"
}
},
"type": "IDP_DISCOVERY"
}

Response samples

200

Content type

application/json

Example

{"accountLink": {"action": "AUTO",
"filter": {"groups": {"include": ["string"
]
}
}
},
"maxClockSkew": 0,
"provisioning": {"action": "AUTO",
"conditions": {"deprovisioned": {"action": "NONE"
},
"suspended": {"action": "NONE"
}
},
"groups": {"action": "NONE",
"assignments": ["string"
],
"filter": ["string"
],
"sourceAttributeName": "string"
},
"profileMaster": true
},
"subject": {"filter": "string",
"format": ["string"
],
"matchAttribute": "string",
"matchType": "USERNAME",
"userNameTemplate": {"template": "string"
}
},
"type": "IDP_DISCOVERY"
}

getPolicy

Gets a policy.

Authorizations:

api_token

path Parameters

policyId

required

string

query Parameters

expand

string

Default: ""

Responses

Response Schema: application/json

	object (PolicyAccountLink)
maxClockSkew	integer
	object (Provisioning)
	object (PolicySubject)

Response samples

200

Content type

application/json

Example

{"accountLink": {"action": "AUTO",
"filter": {"groups": {"include": ["string"
]
}
}
},
"maxClockSkew": 0,
"provisioning": {"action": "AUTO",
"conditions": {"deprovisioned": {"action": "NONE"
},
"suspended": {"action": "NONE"
}
},
"groups": {"action": "NONE",
"assignments": ["string"
],
"filter": ["string"
],
"sourceAttributeName": "string"
},
"profileMaster": true
},
"subject": {"filter": "string",
"format": ["string"
],
"matchAttribute": "string",
"matchType": "USERNAME",
"userNameTemplate": {"template": "string"
}
},
"type": "IDP_DISCOVERY"
}

updatePolicy

Updates a policy.

Authorizations:

api_token

path Parameters

policyId

required

string

Request Body schema: application/json

	object (PolicyAccountLink)
maxClockSkew	integer
	object (Provisioning)
	object (PolicySubject)

Responses

Response Schema: application/json

	object (PolicyAccountLink)
maxClockSkew	integer
	object (Provisioning)
	object (PolicySubject)

Request samples

Content type

application/json

Example

{"accountLink": {"action": "AUTO",
"filter": {"groups": {"include": ["string"
]
}
}
},
"maxClockSkew": 0,
"provisioning": {"action": "AUTO",
"conditions": {"deprovisioned": {"action": "NONE"
},
"suspended": {"action": "NONE"
}
},
"groups": {"action": "NONE",
"assignments": ["string"
],
"filter": ["string"
],
"sourceAttributeName": "string"
},
"profileMaster": true
},
"subject": {"filter": "string",
"format": ["string"
],
"matchAttribute": "string",
"matchType": "USERNAME",
"userNameTemplate": {"template": "string"
}
},
"type": "IDP_DISCOVERY"
}

Response samples

200

Content type

application/json

Example

{"accountLink": {"action": "AUTO",
"filter": {"groups": {"include": ["string"
]
}
}
},
"maxClockSkew": 0,
"provisioning": {"action": "AUTO",
"conditions": {"deprovisioned": {"action": "NONE"
},
"suspended": {"action": "NONE"
}
},
"groups": {"action": "NONE",
"assignments": ["string"
],
"filter": ["string"
],
"sourceAttributeName": "string"
},
"profileMaster": true
},
"subject": {"filter": "string",
"format": ["string"
],
"matchAttribute": "string",
"matchType": "USERNAME",
"userNameTemplate": {"template": "string"
}
},
"type": "IDP_DISCOVERY"
}

deletePolicy

Removes a policy.

Authorizations:

api_token

path Parameters

policyId

required

string

Responses

activatePolicy

Activates a policy.

Authorizations:

api_token

path Parameters

policyId

required

string

Responses

deactivatePolicy

Deactivates a policy.

Authorizations:

api_token

path Parameters

policyId

required

string

Responses

listPolicyRules

Enumerates all policy rules.

Authorizations:

api_token

path Parameters

policyId

required

string

Responses

Response Schema: application/json

Array ()

	object (PasswordPolicyRuleActions)
	object (PasswordPolicyRuleConditions)
name	string

Response samples

200

Content type

application/json

[{"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"priority": 0,
"status": "ACTIVE",
"system": false,
"type": "SIGN_ON",
"name": "string",
"conditions": {"app": {"exclude": [{"id": "string",
"name": "string",
"type": "APP_TYPE"
}
],
"include": [{"id": "string",
"name": "string",
"type": "APP_TYPE"
}
]
},
"apps": {"exclude": ["string"
],
"include": ["string"
]
},
"authContext": {"authType": "ANY"
},
"authProvider": {"include": ["string"
],
"provider": "ACTIVE_DIRECTORY"
},
"beforeScheduledAction": {"duration": {"number": 0,
"unit": "string"
},
"lifecycleAction": {"status": "ACTIVE"
}
},
"clients": {"include": ["string"
]
},
"context": {"expression": "string"
},
"device": {"migrated": true,
"platform": {"supportedMDMFrameworks": ["AFW"
],
"types": ["IOS"
]
},
"rooted": true,
"trustLevel": "ANY"
},
"grantTypes": {"include": ["string"
]
},
"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"identityProvider": {"idpIds": ["string"
],
"provider": "ANY"
},
"mdmEnrollment": {"blockNonSafeAndroid": true,
"enrollment": "OMM"
},
"network": {"connection": "ANYWHERE",
"exclude": ["string"
],
"include": ["string"
]
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
},
"platform": {"exclude": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
],
"include": [{"os": {"expression": "string",
"type": "ANDROID",
"version": {"matchType": "EXPRESSION",
"value": "string"
}
},
"type": "DESKTOP"
}
]
},
"risk": {"behaviors": ["string"
]
},
"riskScore": {"level": "string"
},
"scopes": {"include": ["string"
]
},
"userIdentifier": {"attribute": "string",
"patterns": [{"matchType": "SUFFIX",
"value": "string"
}
],
"type": "IDENTIFIER"
},
"userStatus": {"value": "ACTIVE"
},
"users": {"exclude": ["string"
],
"inactivity": {"number": 0,
"unit": "string"
},
"include": ["string"
],
"lifecycleExpiration": {"lifecycleStatus": "string",
"number": 0,
"unit": "string"
},
"passwordExpiration": {"number": 0,
"unit": "string"
},
"userLifecycleAttribute": {"attributeName": "string",
"matchingValue": "string"
}
}
},
"actions": {"enroll": {"self": "CHALLENGE"
},
"signon": {"access": "ALLOW",
"factorLifetime": 0,
"factorPromptMode": "ALWAYS",
"rememberDeviceByDefault": false,
"requireFactor": false,
"session": {"maxSessionIdleMinutes": 0,
"maxSessionLifetimeMinutes": 0,
"usePersistentCookie": false
}
},
"passwordChange": {"access": "ALLOW"
},
"selfServicePasswordReset": {"access": "ALLOW"
},
"selfServiceUnlock": {"access": "ALLOW"
}
}
}
]

createPolicyRule

Creates a policy rule.

Authorizations:

api_token

path Parameters

policyId

required

string

Request Body schema: application/json

	object (PasswordPolicyRuleActions)
	object (PasswordPolicyRuleConditions)
name	string

Responses

Response Schema: application/json

	object (PasswordPolicyRuleActions)
	object (PasswordPolicyRuleConditions)
name	string

Request samples

Content type

application/json

Example

{"actions": {"passwordChange": {"access": "ALLOW"
},
"selfServicePasswordReset": {"access": "ALLOW"
},
"selfServiceUnlock": {"access": "ALLOW"
}
},
"conditions": {"network": {"connection": "ANYWHERE",
"exclude": ["string"
],
"include": ["string"
]
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
}
},
"name": "string",
"type": "PASSWORD"
}

Response samples

200

Content type

application/json

Example

{"actions": {"passwordChange": {"access": "ALLOW"
},
"selfServicePasswordReset": {"access": "ALLOW"
},
"selfServiceUnlock": {"access": "ALLOW"
}
},
"conditions": {"network": {"connection": "ANYWHERE",
"exclude": ["string"
],
"include": ["string"
]
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
}
},
"name": "string",
"type": "PASSWORD"
}

getPolicyRule

Gets a policy rule.

Authorizations:

api_token

path Parameters

policyId required	string
ruleId required	string

Responses

Response Schema: application/json

	object (PasswordPolicyRuleActions)
	object (PasswordPolicyRuleConditions)
name	string

Response samples

200

Content type

application/json

Example

{"actions": {"passwordChange": {"access": "ALLOW"
},
"selfServicePasswordReset": {"access": "ALLOW"
},
"selfServiceUnlock": {"access": "ALLOW"
}
},
"conditions": {"network": {"connection": "ANYWHERE",
"exclude": ["string"
],
"include": ["string"
]
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
}
},
"name": "string",
"type": "PASSWORD"
}

updatePolicyRule

Updates a policy rule.

Authorizations:

api_token

path Parameters

policyId required	string
ruleId required	string

Request Body schema: application/json

	object (PasswordPolicyRuleActions)
	object (PasswordPolicyRuleConditions)
name	string

Responses

Response Schema: application/json

	object (PasswordPolicyRuleActions)
	object (PasswordPolicyRuleConditions)
name	string

Request samples

Content type

application/json

Example

{"actions": {"passwordChange": {"access": "ALLOW"
},
"selfServicePasswordReset": {"access": "ALLOW"
},
"selfServiceUnlock": {"access": "ALLOW"
}
},
"conditions": {"network": {"connection": "ANYWHERE",
"exclude": ["string"
],
"include": ["string"
]
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
}
},
"name": "string",
"type": "PASSWORD"
}

Response samples

200

Content type

application/json

Example

{"actions": {"passwordChange": {"access": "ALLOW"
},
"selfServicePasswordReset": {"access": "ALLOW"
},
"selfServiceUnlock": {"access": "ALLOW"
}
},
"conditions": {"network": {"connection": "ANYWHERE",
"exclude": ["string"
],
"include": ["string"
]
},
"people": {"groups": {"exclude": ["string"
],
"include": ["string"
]
},
"users": {"exclude": ["string"
],
"include": ["string"
]
}
}
},
"name": "string",
"type": "PASSWORD"
}

deletePolicyRule

Removes a policy rule.

Authorizations:

api_token

path Parameters

policyId required	string
ruleId required	string

Responses

activatePolicyRule

Activates a policy rule.

Authorizations:

api_token

path Parameters

policyId required	string
ruleId required	string

Responses

deactivatePolicyRule

Deactivates a policy rule.

Authorizations:

api_token

path Parameters

policyId required	string
ruleId required	string

Responses

ProfileMapping

listProfileMappings

Enumerates Profile Mappings in your organization with pagination.

Authorizations:

api_token

query Parameters

after	string
limit	integer <int32> Default: -1
sourceId	string
targetId	string Default: ""

Responses

Response Schema: application/json

Array ()

	object
id	string
	object
	object (ProfileMappingSource)
	object (ProfileMappingSource)

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"id": "string",
"properties": {"property1": {"expression": "string",
"pushStatus": "PUSH"
},
"property2": {"expression": "string",
"pushStatus": "PUSH"
}
},
"source": {"_links": {"property1": { },
"property2": { }
},
"id": "string",
"name": "string",
"type": "string"
},
"target": {"_links": {"property1": { },
"property2": { }
},
"id": "string",
"name": "string",
"type": "string"
}
}
]

Get Profile Mapping

Fetches a single Profile Mapping referenced by its ID.

Authorizations:

api_token

path Parameters

mappingId

required

string

Responses

Response Schema: application/json

	object
id	string
	object
	object (ProfileMappingSource)
	object (ProfileMappingSource)

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"id": "string",
"properties": {"property1": {"expression": "string",
"pushStatus": "PUSH"
},
"property2": {"expression": "string",
"pushStatus": "PUSH"
}
},
"source": {"_links": {"property1": { },
"property2": { }
},
"id": "string",
"name": "string",
"type": "string"
},
"target": {"_links": {"property1": { },
"property2": { }
},
"id": "string",
"name": "string",
"type": "string"
}
}

Update Profile Mapping

Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings.

Authorizations:

api_token

path Parameters

mappingId

required

string

Request Body schema: application/json

	object (ProfileMappingSource)
	object (ProfileMappingSource)

Responses

Response Schema: application/json

	object
id	string
	object
	object (ProfileMappingSource)
	object (ProfileMappingSource)

Request samples

Content type

application/json

{"source": { },
"target": { }
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"id": "string",
"properties": {"property1": {"expression": "string",
"pushStatus": "PUSH"
},
"property2": {"expression": "string",
"pushStatus": "PUSH"
}
},
"source": {"_links": {"property1": { },
"property2": { }
},
"id": "string",
"name": "string",
"type": "string"
},
"target": {"_links": {"property1": { },
"property2": { }
},
"id": "string",
"name": "string",
"type": "string"
}
}

Role

Session

Create Session with Session Token

Creates a new session for a user with a valid session token. Use this API if, for example, you want to set the session cookie yourself instead of allowing Okta to set it, or want to hold the session ID in order to delete a session via the API instead of visiting the logout URL.

Authorizations:

api_token

Request Body schema: application/json

sessionToken

string

Responses

Response Schema: application/json

	object
amr	Array of strings (SessionAuthenticationMethod) Items Enum: "pwd" "swk" "hwk" "otp" "sms" "tel" "geo" "fpt" "kba" "mfa"
createdAt	string <date-time>
expiresAt	string <date-time>
id	string
	object (SessionIdentityProvider)
lastFactorVerification	string <date-time>
lastPasswordVerification	string <date-time>
login	string
status	string (SessionStatus) Enum: "ACTIVE" "MFA_ENROLL" "MFA_REQUIRED"
userId	string

Request samples

Content type

application/json

{"sessionToken": "string"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"amr": ["pwd"
],
"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"idp": {"id": "string",
"type": "ACTIVE_DIRECTORY"
},
"lastFactorVerification": "2019-08-24T14:15:22Z",
"lastPasswordVerification": "2019-08-24T14:15:22Z",
"login": "string",
"status": "ACTIVE",
"userId": "string"
}

Get Session

Get details about a session.

Authorizations:

api_token

path Parameters

sessionId

required

string

Responses

Response Schema: application/json

	object
amr	Array of strings (SessionAuthenticationMethod) Items Enum: "pwd" "swk" "hwk" "otp" "sms" "tel" "geo" "fpt" "kba" "mfa"
createdAt	string <date-time>
expiresAt	string <date-time>
id	string
	object (SessionIdentityProvider)
lastFactorVerification	string <date-time>
lastPasswordVerification	string <date-time>
login	string
status	string (SessionStatus) Enum: "ACTIVE" "MFA_ENROLL" "MFA_REQUIRED"
userId	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"amr": ["pwd"
],
"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"idp": {"id": "string",
"type": "ACTIVE_DIRECTORY"
},
"lastFactorVerification": "2019-08-24T14:15:22Z",
"lastPasswordVerification": "2019-08-24T14:15:22Z",
"login": "string",
"status": "ACTIVE",
"userId": "string"
}

End Session

End a session.

Authorizations:

api_token

path Parameters

sessionId

required

string

Responses

Refresh Session

Refresh a session.

Authorizations:

api_token

path Parameters

sessionId

required

string

Responses

Response Schema: application/json

	object
amr	Array of strings (SessionAuthenticationMethod) Items Enum: "pwd" "swk" "hwk" "otp" "sms" "tel" "geo" "fpt" "kba" "mfa"
createdAt	string <date-time>
expiresAt	string <date-time>
id	string
	object (SessionIdentityProvider)
lastFactorVerification	string <date-time>
lastPasswordVerification	string <date-time>
login	string
status	string (SessionStatus) Enum: "ACTIVE" "MFA_ENROLL" "MFA_REQUIRED"
userId	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"amr": ["pwd"
],
"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"idp": {"id": "string",
"type": "ACTIVE_DIRECTORY"
},
"lastFactorVerification": "2019-08-24T14:15:22Z",
"lastPasswordVerification": "2019-08-24T14:15:22Z",
"login": "string",
"status": "ACTIVE",
"userId": "string"
}

Template

List SMS Templates

Enumerates custom SMS templates in your organization. A subset of templates can be returned that match a template type.

Authorizations:

api_token

query Parameters

templateType

string (SmsTemplateType)

Value: "SMS_VERIFY_CODE"

Responses

Response Schema: application/json

Array ()

created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
template	string
translations	object (SmsTemplateTranslations)
type	string (SmsTemplateType) Value: "SMS_VERIFY_CODE"

Response samples

200

Content type

application/json

[{"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"template": "string",
"translations": { },
"type": "SMS_VERIFY_CODE"
}
]

Add SMS Template

Adds a new custom SMS template to your organization.

Authorizations:

api_token

Request Body schema: application/json

name	string
template	string
translations	object (SmsTemplateTranslations)
type	string (SmsTemplateType) Value: "SMS_VERIFY_CODE"

Responses

Response Schema: application/json

created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
template	string
translations	object (SmsTemplateTranslations)
type	string (SmsTemplateType) Value: "SMS_VERIFY_CODE"

Request samples

Content type

application/json

{"name": "string",
"template": "string",
"translations": { },
"type": "SMS_VERIFY_CODE"
}

Response samples

200

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"template": "string",
"translations": { },
"type": "SMS_VERIFY_CODE"
}

Get SMS Template

Fetches a specific template by id

Authorizations:

api_token

path Parameters

templateId

required

string

Responses

Response Schema: application/json

created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
template	string
translations	object (SmsTemplateTranslations)
type	string (SmsTemplateType) Value: "SMS_VERIFY_CODE"

Response samples

200

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"template": "string",
"translations": { },
"type": "SMS_VERIFY_CODE"
}

Update SMS Template

Updates the SMS template.

Authorizations:

api_token

path Parameters

templateId

required

string

Request Body schema: application/json

name	string
template	string
translations	object (SmsTemplateTranslations)
type	string (SmsTemplateType) Value: "SMS_VERIFY_CODE"

Responses

Response Schema: application/json

created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
template	string
translations	object (SmsTemplateTranslations)
type	string (SmsTemplateType) Value: "SMS_VERIFY_CODE"

Request samples

Content type

application/json

{"name": "string",
"template": "string",
"translations": { },
"type": "SMS_VERIFY_CODE"
}

Response samples

200

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"template": "string",
"translations": { },
"type": "SMS_VERIFY_CODE"
}

Partial SMS Template Update

Updates only some of the SMS template properties:

Authorizations:

api_token

path Parameters

templateId

required

string

Request Body schema: application/json

name	string
template	string
translations	object (SmsTemplateTranslations)
type	string (SmsTemplateType) Value: "SMS_VERIFY_CODE"

Responses

Response Schema: application/json

created	string <date-time>
id	string
lastUpdated	string <date-time>
name	string
template	string
translations	object (SmsTemplateTranslations)
type	string (SmsTemplateType) Value: "SMS_VERIFY_CODE"

Request samples

Content type

application/json

{"name": "string",
"template": "string",
"translations": { },
"type": "SMS_VERIFY_CODE"
}

Response samples

200

Content type

application/json

{"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"template": "string",
"translations": { },
"type": "SMS_VERIFY_CODE"
}

Remove SMS Template

Removes an SMS template.

Authorizations:

api_token

path Parameters

templateId

required

string

Responses

ThreatInsight

getCurrentConfiguration

Gets current ThreatInsight configuration

Authorizations:

api_token

Responses

Response Schema: application/json

	object
action	string
created	string <date-time>
excludeZones	Array of strings
lastUpdated	string <date-time>

Response samples

200

Content type

application/json

{"action": "string",
"excludeZones": ["string"
],
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"_links": {"property1": { },
"property2": { }
}
}

updateConfiguration

Updates ThreatInsight configuration

Authorizations:

api_token

Request Body schema: application/json

action	string
excludeZones	Array of strings

Responses

Response Schema: application/json

	object
action	string
created	string <date-time>
excludeZones	Array of strings
lastUpdated	string <date-time>

Request samples

Content type

application/json

{"action": "string",
"excludeZones": ["string"
]
}

Response samples

200

Content type

application/json

{"action": "string",
"excludeZones": ["string"
],
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"_links": {"property1": { },
"property2": { }
}
}

TrustedOrigin

listOrigins

Success

Authorizations:

api_token

query Parameters

after	string
filter	string
limit	integer <int32> Default: -1
q	string

Responses

Response Schema: application/json

Array ()

	object
created	string <date-time>
createdBy	string
id	string
lastUpdated	string <date-time>
lastUpdatedBy	string
name	string
origin	string
	Array of objects (Scope)
status	string

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string",
"origin": "string",
"scopes": [{"stringValue": "string",
"type": "CORS"
}
],
"status": "string"
}
]

createOrigin

Success

Authorizations:

api_token

Request Body schema: application/json

createdBy	string
lastUpdatedBy	string
name	string
origin	string
	Array of objects (Scope)
status	string

Responses

Response Schema: application/json

	object
created	string <date-time>
createdBy	string
id	string
lastUpdated	string <date-time>
lastUpdatedBy	string
name	string
origin	string
	Array of objects (Scope)
status	string

Request samples

Content type

application/json

{"createdBy": "string",
"lastUpdatedBy": "string",
"name": "string",
"origin": "string",
"scopes": [{"stringValue": "string",
"type": "CORS"
}
],
"status": "string"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string",
"origin": "string",
"scopes": [{"stringValue": "string",
"type": "CORS"
}
],
"status": "string"
}

getOrigin

Success

Authorizations:

api_token

path Parameters

trustedOriginId

required

string

Responses

Response Schema: application/json

	object
created	string <date-time>
createdBy	string
id	string
lastUpdated	string <date-time>
lastUpdatedBy	string
name	string
origin	string
	Array of objects (Scope)
status	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string",
"origin": "string",
"scopes": [{"stringValue": "string",
"type": "CORS"
}
],
"status": "string"
}

updateOrigin

Success

Authorizations:

api_token

path Parameters

trustedOriginId

required

string

Request Body schema: application/json

createdBy	string
lastUpdatedBy	string
name	string
origin	string
	Array of objects (Scope)
status	string

Responses

Response Schema: application/json

	object
created	string <date-time>
createdBy	string
id	string
lastUpdated	string <date-time>
lastUpdatedBy	string
name	string
origin	string
	Array of objects (Scope)
status	string

Request samples

Content type

application/json

{"createdBy": "string",
"lastUpdatedBy": "string",
"name": "string",
"origin": "string",
"scopes": [{"stringValue": "string",
"type": "CORS"
}
],
"status": "string"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string",
"origin": "string",
"scopes": [{"stringValue": "string",
"type": "CORS"
}
],
"status": "string"
}

deleteOrigin

Success

Authorizations:

api_token

path Parameters

trustedOriginId

required

string

Responses

activateOrigin

Success

Authorizations:

api_token

path Parameters

trustedOriginId

required

string

Responses

Response Schema: application/json

	object
created	string <date-time>
createdBy	string
id	string
lastUpdated	string <date-time>
lastUpdatedBy	string
name	string
origin	string
	Array of objects (Scope)
status	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string",
"origin": "string",
"scopes": [{"stringValue": "string",
"type": "CORS"
}
],
"status": "string"
}

deactivateOrigin

Success

Authorizations:

api_token

path Parameters

trustedOriginId

required

string

Responses

Response Schema: application/json

	object
created	string <date-time>
createdBy	string
id	string
lastUpdated	string <date-time>
lastUpdatedBy	string
name	string
origin	string
	Array of objects (Scope)
status	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string",
"origin": "string",
"scopes": [{"stringValue": "string",
"type": "CORS"
}
],
"status": "string"
}

User

List Users

Lists users in your organization with pagination in most cases. A subset of users can be returned that match a supported filter expression or search criteria.

Authorizations:

api_token

query Parameters

after	string Specifies the pagination cursor for the next page of users
filter	string Filters users with a supported expression for a subset of properties
limit	integer <int32> Default: 10 Specifies the number of results returned
q	string Finds a user that matches firstName, lastName, and email properties
search	string Searches for users with a supported filtering expression for most properties
sortBy	string
sortOrder	string

Responses

Response Schema: application/json

Array ()

	object
	object
activated	string <date-time>
created	string <date-time>
	object (UserCredentials)
id	string
lastLogin	string <date-time>
lastUpdated	string <date-time>
passwordChanged	string <date-time>
	object (UserProfile)
status	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
statusChanged	string <date-time>
transitioningToStatus	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
	object (UserType)

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"activated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
},
"id": "string",
"lastLogin": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"passwordChanged": "2019-08-24T14:15:22Z",
"profile": {"city": "string",
"costCenter": "string",
"countryCode": "string",
"department": "string",
"displayName": "string",
"division": "string",
"email": "string",
"employeeNumber": "string",
"firstName": "string",
"honorificPrefix": "string",
"honorificSuffix": "string",
"lastName": "string",
"locale": "string",
"login": "string",
"manager": "string",
"managerId": "string",
"middleName": "string",
"mobilePhone": "string",
"nickName": "string",
"organization": "string",
"postalAddress": "string",
"preferredLanguage": "string",
"primaryPhone": "string",
"profileUrl": "string",
"secondEmail": "string",
"state": "string",
"streetAddress": "string",
"timezone": "string",
"title": "string",
"userType": "string",
"zipCode": "string"
},
"status": "ACTIVE",
"statusChanged": "2019-08-24T14:15:22Z",
"transitioningToStatus": "ACTIVE",
"type": {"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string"
}
}
]

Create User

Creates a new user in your Okta organization with or without credentials.

Authorizations:

api_token

query Parameters

activate	boolean Default: true Executes activation lifecycle operation when creating the user
nextLogin	string (UserNextLogin) Value: "changePassword" With activate=true, set nextLogin to "changePassword" to have the password be EXPIRED, so user must change it the next time they log in.
provider	boolean Default: false Indicates whether to create a user with a specified authentication provider

Request Body schema: application/json

	object (UserCredentials)
groupIds	Array of strings
	object (UserProfile)
	object (UserType)

Responses

Response Schema: application/json

	object
	object
activated	string <date-time>
created	string <date-time>
	object (UserCredentials)
id	string
lastLogin	string <date-time>
lastUpdated	string <date-time>
passwordChanged	string <date-time>
	object (UserProfile)
status	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
statusChanged	string <date-time>
transitioningToStatus	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
	object (UserType)

Request samples

Content type

application/json

{"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
},
"groupIds": ["string"
],
"profile": {"city": "string",
"costCenter": "string",
"countryCode": "string",
"department": "string",
"displayName": "string",
"division": "string",
"email": "string",
"employeeNumber": "string",
"firstName": "string",
"honorificPrefix": "string",
"honorificSuffix": "string",
"lastName": "string",
"locale": "string",
"login": "string",
"manager": "string",
"managerId": "string",
"middleName": "string",
"mobilePhone": "string",
"nickName": "string",
"organization": "string",
"postalAddress": "string",
"preferredLanguage": "string",
"primaryPhone": "string",
"profileUrl": "string",
"secondEmail": "string",
"state": "string",
"streetAddress": "string",
"timezone": "string",
"title": "string",
"userType": "string",
"zipCode": "string"
},
"type": {"description": "string",
"displayName": "string",
"id": "string",
"name": "string"
}
}

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"activated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
},
"id": "string",
"lastLogin": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"passwordChanged": "2019-08-24T14:15:22Z",
"profile": {"city": "string",
"costCenter": "string",
"countryCode": "string",
"department": "string",
"displayName": "string",
"division": "string",
"email": "string",
"employeeNumber": "string",
"firstName": "string",
"honorificPrefix": "string",
"honorificSuffix": "string",
"lastName": "string",
"locale": "string",
"login": "string",
"manager": "string",
"managerId": "string",
"middleName": "string",
"mobilePhone": "string",
"nickName": "string",
"organization": "string",
"postalAddress": "string",
"preferredLanguage": "string",
"primaryPhone": "string",
"profileUrl": "string",
"secondEmail": "string",
"state": "string",
"streetAddress": "string",
"timezone": "string",
"title": "string",
"userType": "string",
"zipCode": "string"
},
"status": "ACTIVE",
"statusChanged": "2019-08-24T14:15:22Z",
"transitioningToStatus": "ACTIVE",
"type": {"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string"
}
}

Set Linked Object for User

Sets a linked object for a user.

path Parameters

associatedUserId required	string
primaryRelationshipName required	string
primaryUserId required	string

Responses

Get User

Fetches a user from your Okta organization.

Authorizations:

api_token

path Parameters

userId

required

string

Responses

Response Schema: application/json

	object
	object
activated	string <date-time>
created	string <date-time>
	object (UserCredentials)
id	string
lastLogin	string <date-time>
lastUpdated	string <date-time>
passwordChanged	string <date-time>
	object (UserProfile)
status	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
statusChanged	string <date-time>
transitioningToStatus	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
	object (UserType)

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"activated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
},
"id": "string",
"lastLogin": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"passwordChanged": "2019-08-24T14:15:22Z",
"profile": {"city": "string",
"costCenter": "string",
"countryCode": "string",
"department": "string",
"displayName": "string",
"division": "string",
"email": "string",
"employeeNumber": "string",
"firstName": "string",
"honorificPrefix": "string",
"honorificSuffix": "string",
"lastName": "string",
"locale": "string",
"login": "string",
"manager": "string",
"managerId": "string",
"middleName": "string",
"mobilePhone": "string",
"nickName": "string",
"organization": "string",
"postalAddress": "string",
"preferredLanguage": "string",
"primaryPhone": "string",
"profileUrl": "string",
"secondEmail": "string",
"state": "string",
"streetAddress": "string",
"timezone": "string",
"title": "string",
"userType": "string",
"zipCode": "string"
},
"status": "ACTIVE",
"statusChanged": "2019-08-24T14:15:22Z",
"transitioningToStatus": "ACTIVE",
"type": {"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string"
}
}

Update User

Update a user's profile and/or credentials using strict-update semantics.

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

strict

boolean

Request Body schema: application/json

	object (UserCredentials)
	object (UserProfile)
status	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
transitioningToStatus	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
	object (UserType)

Responses

Response Schema: application/json

	object
	object
activated	string <date-time>
created	string <date-time>
	object (UserCredentials)
id	string
lastLogin	string <date-time>
lastUpdated	string <date-time>
passwordChanged	string <date-time>
	object (UserProfile)
status	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
statusChanged	string <date-time>
transitioningToStatus	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
	object (UserType)

Request samples

Content type

application/json

{"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
},
"profile": {"city": "string",
"costCenter": "string",
"countryCode": "string",
"department": "string",
"displayName": "string",
"division": "string",
"email": "string",
"employeeNumber": "string",
"firstName": "string",
"honorificPrefix": "string",
"honorificSuffix": "string",
"lastName": "string",
"locale": "string",
"login": "string",
"manager": "string",
"managerId": "string",
"middleName": "string",
"mobilePhone": "string",
"nickName": "string",
"organization": "string",
"postalAddress": "string",
"preferredLanguage": "string",
"primaryPhone": "string",
"profileUrl": "string",
"secondEmail": "string",
"state": "string",
"streetAddress": "string",
"timezone": "string",
"title": "string",
"userType": "string",
"zipCode": "string"
},
"status": "ACTIVE",
"transitioningToStatus": "ACTIVE",
"type": {"description": "string",
"displayName": "string",
"id": "string",
"name": "string"
}
}

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"activated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
},
"id": "string",
"lastLogin": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"passwordChanged": "2019-08-24T14:15:22Z",
"profile": {"city": "string",
"costCenter": "string",
"countryCode": "string",
"department": "string",
"displayName": "string",
"division": "string",
"email": "string",
"employeeNumber": "string",
"firstName": "string",
"honorificPrefix": "string",
"honorificSuffix": "string",
"lastName": "string",
"locale": "string",
"login": "string",
"manager": "string",
"managerId": "string",
"middleName": "string",
"mobilePhone": "string",
"nickName": "string",
"organization": "string",
"postalAddress": "string",
"preferredLanguage": "string",
"primaryPhone": "string",
"profileUrl": "string",
"secondEmail": "string",
"state": "string",
"streetAddress": "string",
"timezone": "string",
"title": "string",
"userType": "string",
"zipCode": "string"
},
"status": "ACTIVE",
"statusChanged": "2019-08-24T14:15:22Z",
"transitioningToStatus": "ACTIVE",
"type": {"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string"
}
}

partialUpdateUser

Fetch a user by id, login, or login shortname if the short name is unambiguous.

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

strict

boolean

Request Body schema: application/json

	object (UserCredentials)
	object (UserProfile)
status	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
transitioningToStatus	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
	object (UserType)

Responses

Response Schema: application/json

	object
	object
activated	string <date-time>
created	string <date-time>
	object (UserCredentials)
id	string
lastLogin	string <date-time>
lastUpdated	string <date-time>
passwordChanged	string <date-time>
	object (UserProfile)
status	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
statusChanged	string <date-time>
transitioningToStatus	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
	object (UserType)

Request samples

Content type

application/json

{"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
},
"profile": {"city": "string",
"costCenter": "string",
"countryCode": "string",
"department": "string",
"displayName": "string",
"division": "string",
"email": "string",
"employeeNumber": "string",
"firstName": "string",
"honorificPrefix": "string",
"honorificSuffix": "string",
"lastName": "string",
"locale": "string",
"login": "string",
"manager": "string",
"managerId": "string",
"middleName": "string",
"mobilePhone": "string",
"nickName": "string",
"organization": "string",
"postalAddress": "string",
"preferredLanguage": "string",
"primaryPhone": "string",
"profileUrl": "string",
"secondEmail": "string",
"state": "string",
"streetAddress": "string",
"timezone": "string",
"title": "string",
"userType": "string",
"zipCode": "string"
},
"status": "ACTIVE",
"transitioningToStatus": "ACTIVE",
"type": {"description": "string",
"displayName": "string",
"id": "string",
"name": "string"
}
}

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"activated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
},
"id": "string",
"lastLogin": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"passwordChanged": "2019-08-24T14:15:22Z",
"profile": {"city": "string",
"costCenter": "string",
"countryCode": "string",
"department": "string",
"displayName": "string",
"division": "string",
"email": "string",
"employeeNumber": "string",
"firstName": "string",
"honorificPrefix": "string",
"honorificSuffix": "string",
"lastName": "string",
"locale": "string",
"login": "string",
"manager": "string",
"managerId": "string",
"middleName": "string",
"mobilePhone": "string",
"nickName": "string",
"organization": "string",
"postalAddress": "string",
"preferredLanguage": "string",
"primaryPhone": "string",
"profileUrl": "string",
"secondEmail": "string",
"state": "string",
"streetAddress": "string",
"timezone": "string",
"title": "string",
"userType": "string",
"zipCode": "string"
},
"status": "ACTIVE",
"statusChanged": "2019-08-24T14:15:22Z",
"transitioningToStatus": "ACTIVE",
"type": {"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string"
}
}

Delete User

Deletes a user permanently. This operation can only be performed on users that have a DEPROVISIONED status. This action cannot be recovered!

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

sendEmail

boolean

Default: false

Responses

Get Assigned App Links

Fetches appLinks for all direct or indirect (via group membership) assigned applications.

Authorizations:

api_token

path Parameters

userId

required

string

Responses

Response Schema: application/json

Array ()

appAssignmentId	string
appInstanceId	string
appName	string
credentialsSetup	boolean
hidden	boolean
id	string
label	string
linkUrl	string
logoUrl	string
sortOrder	integer

Response samples

200

Content type

application/json

[{"appAssignmentId": "string",
"appInstanceId": "string",
"appName": "string",
"credentialsSetup": true,
"hidden": true,
"id": "string",
"label": "string",
"linkUrl": "string",
"logoUrl": "string",
"sortOrder": 0
}
]

listUserClients

Lists all client resources for which the specified user has grants or tokens.

Authorizations:

api_token

path Parameters

userId

required

string

Responses

Response Schema: application/json

Array ()

	object
client_id	string
client_name	string
client_uri	string
logo_uri	string

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"client_id": "string",
"client_name": "string",
"client_uri": "string",
"logo_uri": "string"
}
]

listGrantsForUserAndClient

Lists all grants for a specified user and client

Authorizations:

api_token

path Parameters

clientId required	string
userId required	string

query Parameters

after	string
expand	string
limit	integer <int32> Default: 20

Responses

Response Schema: application/json

Array ()

	object
	object
clientId	string
created	string <date-time>
	object (OAuth2Actor)
id	string
issuer	string
lastUpdated	string <date-time>
scopeId	string
source	string (OAuth2ScopeConsentGrantSource) Enum: "END_USER" "ADMIN"
status	string (OAuth2ScopeConsentGrantStatus) Enum: "ACTIVE" "REVOKED"
userId	string

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"clientId": "string",
"userId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": {"id": "string",
"type": "string"
},
"id": "string",
"issuer": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"scopeId": "string",
"source": "END_USER",
"status": "ACTIVE"
}
]

revokeGrantsForUserAndClient

Revokes all grants for the specified user and client

Authorizations:

api_token

path Parameters

clientId required	string
userId required	string

Responses

listRefreshTokensForUserAndClient

Lists all refresh tokens issued for the specified User and Client.

Authorizations:

api_token

path Parameters

clientId required	string
userId required	string

query Parameters

after	string
expand	string
limit	integer <int32> Default: 20

Responses

Response Schema: application/json

Array ()

	object
	object
clientId	string
created	string <date-time>
	object (OAuth2Actor)
expiresAt	string <date-time>
id	string
issuer	string
lastUpdated	string <date-time>
scopes	Array of strings
status	string Enum: "ACTIVE" "REVOKED"
userId	string

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": {"id": "string",
"type": "string"
},
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"issuer": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"scopes": ["string"
],
"status": "ACTIVE",
"userId": "string"
}
]

revokeTokensForUserAndClient

Revokes all refresh tokens issued for the specified User and Client.

Authorizations:

api_token

path Parameters

clientId required	string
userId required	string

Responses

getRefreshTokenForUserAndClient

Gets a refresh token issued for the specified User and Client.

Authorizations:

api_token

path Parameters

clientId required	string
tokenId required	string
userId required	string

query Parameters

after	string
expand	string
limit	integer Default: 20

Responses

Response Schema: application/json

	object
	object
clientId	string
created	string <date-time>
	object (OAuth2Actor)
expiresAt	string <date-time>
id	string
issuer	string
lastUpdated	string <date-time>
scopes	Array of strings
status	string Enum: "ACTIVE" "REVOKED"
userId	string

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"clientId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": {"id": "string",
"type": "string"
},
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"issuer": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"scopes": ["string"
],
"status": "ACTIVE",
"userId": "string"
}

revokeTokenForUserAndClient

Revokes the specified refresh token.

Authorizations:

api_token

path Parameters

clientId required	string
tokenId required	string
userId required	string

Responses

Change Password

Changes a user's password by validating the user's current password. This operation can only be performed on users in STAGED, ACTIVE, PASSWORD_EXPIRED, or RECOVERY status that have a valid password credential

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

strict

boolean

Request Body schema: application/json

	object (PasswordCredential)
	object (PasswordCredential)

Responses

Response Schema: application/json

	object (PasswordCredential)
	object (AuthenticationProvider)
	object (RecoveryQuestionCredential)

Request samples

Content type

application/json

{"newPassword": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"oldPassword": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
}
}

Response samples

200

Content type

application/json

{"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
}

Change Recovery Question

Changes a user's recovery question & answer credential by validating the user's current password. This operation can only be performed on users in STAGED, ACTIVE or RECOVERY status that have a valid password credential

Authorizations:

api_token

path Parameters

userId

required

string

Request Body schema: application/json

	object (PasswordCredential)
	object (AuthenticationProvider)
	object (RecoveryQuestionCredential)

Responses

Response Schema: application/json

	object (PasswordCredential)
	object (AuthenticationProvider)
	object (RecoveryQuestionCredential)

Request samples

Content type

application/json

{"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
}

Response samples

200

Content type

application/json

{"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
}

Initiate Forgot Password

Initiate forgot password flow. Generates a one-time token (OTT) that can be used to reset a user's password.

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

sendEmail

boolean

Default: true

Responses

Response Schema: application/json

resetPasswordUrl

string

Response samples

200

Content type

application/json

{"resetPasswordUrl": "string"
}

Reset Password with Recovery Question

Resets the user's password to the specified password if the provided answer to the recovery question is correct.

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

sendEmail

boolean

Default: true

Request Body schema: application/json

	object (PasswordCredential)
	object (AuthenticationProvider)
	object (RecoveryQuestionCredential)

Responses

Response Schema: application/json

	object (PasswordCredential)
	object (AuthenticationProvider)
	object (RecoveryQuestionCredential)

Request samples

Content type

application/json

{"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
}

Response samples

200

Content type

application/json

{"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
}

listUserGrants

Lists all grants for the specified user

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

after	string
expand	string
limit	integer <int32> Default: 20
scopeId	string

Responses

Response Schema: application/json

Array ()

	object
	object
clientId	string
created	string <date-time>
	object (OAuth2Actor)
id	string
issuer	string
lastUpdated	string <date-time>
scopeId	string
source	string (OAuth2ScopeConsentGrantSource) Enum: "END_USER" "ADMIN"
status	string (OAuth2ScopeConsentGrantStatus) Enum: "ACTIVE" "REVOKED"
userId	string

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"clientId": "string",
"userId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": {"id": "string",
"type": "string"
},
"id": "string",
"issuer": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"scopeId": "string",
"source": "END_USER",
"status": "ACTIVE"
}
]

revokeUserGrants

Revokes all grants for a specified user

Authorizations:

api_token

path Parameters

userId

required

string

Responses

getUserGrant

Gets a grant for the specified user

Authorizations:

api_token

path Parameters

grantId required	string
userId required	string

query Parameters

expand

string

Responses

Response Schema: application/json

	object
	object
clientId	string
created	string <date-time>
	object (OAuth2Actor)
id	string
issuer	string
lastUpdated	string <date-time>
scopeId	string
source	string (OAuth2ScopeConsentGrantSource) Enum: "END_USER" "ADMIN"
status	string (OAuth2ScopeConsentGrantStatus) Enum: "ACTIVE" "REVOKED"
userId	string

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"clientId": "string",
"userId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": {"id": "string",
"type": "string"
},
"id": "string",
"issuer": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"scopeId": "string",
"source": "END_USER",
"status": "ACTIVE"
}

revokeUserGrant

Revokes one grant for a specified user

Authorizations:

api_token

path Parameters

grantId required	string
userId required	string

Responses

Get Member Groups

Fetches the groups of which the user is a member.

Authorizations:

api_token

path Parameters

userId

required

string

Responses

Response Schema: application/json

Array ()

	object
	object
created	string <date-time>
id	string
lastMembershipUpdated	string <date-time>
lastUpdated	string <date-time>
objectClass	Array of strings
	object (GroupProfile)
type	string (GroupType) Enum: "OKTA_GROUP" "APP_GROUP" "BUILT_IN"

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastMembershipUpdated": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"objectClass": ["string"
],
"profile": {"description": "string",
"name": "string"
},
"type": "OKTA_GROUP"
}
]

Listing IdPs associated with a user

Lists the IdPs associated with the user.

Authorizations:

api_token

path Parameters

userId

required

string

Responses

Response Schema: application/json

Array ()

	object
created	string <date-time>
id	string
issuerMode	string Enum: "ORG_URL" "CUSTOM_URL_DOMAIN"
lastUpdated	string <date-time>
name	string
	object (IdentityProviderPolicy)
	object (Protocol)
status	string Enum: "ACTIVE" "INACTIVE"
type	string

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"issuerMode": "ORG_URL",
"lastUpdated": "2019-08-24T14:15:22Z",
"name": "string",
"policy": {"accountLink": {"action": "AUTO",
"filter": {"groups": {"include": ["string"
]
}
}
},
"maxClockSkew": 0,
"provisioning": {"action": "AUTO",
"conditions": {"deprovisioned": {"action": "NONE"
},
"suspended": {"action": "NONE"
}
},
"groups": {"action": "NONE",
"assignments": ["string"
],
"filter": ["string"
],
"sourceAttributeName": "string"
},
"profileMaster": true
},
"subject": {"filter": "string",
"format": ["string"
],
"matchAttribute": "string",
"matchType": "USERNAME",
"userNameTemplate": {"template": "string"
}
}
},
"protocol": {"algorithms": {"request": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
},
"response": {"signature": {"algorithm": "string",
"scope": "RESPONSE"
}
}
},
"credentials": {"client": {"client_id": "string",
"client_secret": "string"
},
"signing": {"kid": "string"
},
"trust": {"audience": "string",
"issuer": "string",
"kid": "string",
"revocation": "CRL",
"revocationCacheLifetime": 0
}
},
"endpoints": {"acs": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"authorization": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"jwks": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"metadata": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"slo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"sso": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"token": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"userInfo": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
}
},
"issuer": {"binding": "HTTP-POST",
"destination": "string",
"type": "INSTANCE",
"url": "string"
},
"relayState": {"format": "OPAQUE"
},
"scopes": ["string"
],
"settings": {"nameFormat": "string"
},
"type": "SAML2"
},
"status": "ACTIVE",
"type": "string"
}
]

Activate User

Activates a user. This operation can only be performed on users with a STAGED status. Activation of a user is an asynchronous operation. The user will have the transitioningToStatus property with a value of ACTIVE during activation to indicate that the user hasn't completed the asynchronous operation. The user will have a status of ACTIVE when the activation process is complete.

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

sendEmail

required

boolean

Default: true

Sends an activation email to the user if true

Responses

Response Schema: application/json

activationToken	string
activationUrl	string

Response samples

200

Content type

application/json

{"activationToken": "string",
"activationUrl": "string"
}

Deactivate User

Deactivates a user. This operation can only be performed on users that do not have a DEPROVISIONED status. Deactivation of a user is an asynchronous operation. The user will have the transitioningToStatus property with a value of DEPROVISIONED during deactivation to indicate that the user hasn't completed the asynchronous operation. The user will have a status of DEPROVISIONED when the deactivation process is complete.

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

sendEmail

boolean

Default: false

Responses

Expire Password

This operation transitions the user to the status of PASSWORD_EXPIRED so that the user is required to change their password at their next login.

Authorizations:

api_token

path Parameters

userId

required

string

Responses

Response Schema: application/json

	object
	object
activated	string <date-time>
created	string <date-time>
	object (UserCredentials)
id	string
lastLogin	string <date-time>
lastUpdated	string <date-time>
passwordChanged	string <date-time>
	object (UserProfile)
status	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
statusChanged	string <date-time>
transitioningToStatus	string (UserStatus) Enum: "ACTIVE" "DEPROVISIONED" "LOCKED_OUT" "PASSWORD_EXPIRED" "PROVISIONED" "RECOVERY" "STAGED" "SUSPENDED"
	object (UserType)

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"activated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"credentials": {"password": {"hash": {"algorithm": "BCRYPT",
"salt": "string",
"saltOrder": "string",
"value": "string",
"workFactor": 0
},
"hook": {"type": "string"
},
"value": "pa$$word"
},
"provider": {"name": "string",
"type": "ACTIVE_DIRECTORY"
},
"recovery_question": {"answer": "string",
"question": "string"
}
},
"id": "string",
"lastLogin": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"passwordChanged": "2019-08-24T14:15:22Z",
"profile": {"city": "string",
"costCenter": "string",
"countryCode": "string",
"department": "string",
"displayName": "string",
"division": "string",
"email": "string",
"employeeNumber": "string",
"firstName": "string",
"honorificPrefix": "string",
"honorificSuffix": "string",
"lastName": "string",
"locale": "string",
"login": "string",
"manager": "string",
"managerId": "string",
"middleName": "string",
"mobilePhone": "string",
"nickName": "string",
"organization": "string",
"postalAddress": "string",
"preferredLanguage": "string",
"primaryPhone": "string",
"profileUrl": "string",
"secondEmail": "string",
"state": "string",
"streetAddress": "string",
"timezone": "string",
"title": "string",
"userType": "string",
"zipCode": "string"
},
"status": "ACTIVE",
"statusChanged": "2019-08-24T14:15:22Z",
"transitioningToStatus": "ACTIVE",
"type": {"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string"
}
}

Expire Password and Set Temporary Password

This operation transitions the user to the status of PASSWORD_EXPIRED so that the user is required to change their password at their next login, and also sets the user's password to a temporary password returned in the response.

Authorizations:

api_token

path Parameters

userId

required

string

Responses

Response Schema: application/json

tempPassword

string

Response samples

200

Content type

application/json

{"tempPassword": "string"
}

Reactivate User

Reactivates a user. This operation can only be performed on users with a PROVISIONED status. This operation restarts the activation workflow if for some reason the user activation was not completed when using the activationToken from Activate User.

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

sendEmail

boolean

Default: false

Sends an activation email to the user if true

Responses

Response Schema: application/json

activationToken	string
activationUrl	string

Response samples

200

Content type

application/json

{"activationToken": "string",
"activationUrl": "string"
}

Reset Factors

This operation resets all factors for the specified user. All MFA factor enrollments returned to the unenrolled state. The user's status remains ACTIVE. This link is present only if the user is currently enrolled in one or more MFA factors.

Authorizations:

api_token

path Parameters

userId

required

string

Responses

Reset Password

Generates a one-time token (OTT) that can be used to reset a user's password. The OTT link can be automatically emailed to the user or returned to the API caller and distributed using a custom flow.

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

sendEmail

required

boolean

Responses

Response Schema: application/json

resetPasswordUrl

string

Response samples

200

Content type

application/json

{"resetPasswordUrl": "string"
}

Suspend User

Suspends a user. This operation can only be performed on users with an ACTIVE status. The user will have a status of SUSPENDED when the process is complete.

Authorizations:

api_token

path Parameters

userId

required

string

Responses

Unlock User

Unlocks a user with a LOCKED_OUT status and returns them to ACTIVE status. Users will be able to login with their current password.

Authorizations:

api_token

path Parameters

userId

required

string

Responses

Unsuspend User

Unsuspends a user and returns them to the ACTIVE state. This operation can only be performed on users that have a SUSPENDED status.

Authorizations:

api_token

path Parameters

userId

required

string

Responses

getLinkedObjectsForUser

Get linked objects for a user, relationshipName can be a primary or associated relationship name

Authorizations:

api_token

path Parameters

relationshipName required	string
userId required	string

query Parameters

after	string
limit	integer <int32> Default: -1

Responses

Response Schema: application/json

Array ()

object (ResponseLinks)

Response samples

200

Content type

application/json

[{ }
]

removeLinkedObjectForUser

Delete linked objects for a user, relationshipName can be ONLY a primary relationship name

Authorizations:

api_token

path Parameters

relationshipName required	string
userId required	string

Responses

listAssignedRolesForUser

Lists all roles assigned to a user.

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

expand

string

Responses

Response Schema: application/json

Array ()

	object
	object
assignmentType	string (RoleAssignmentType) Enum: "GROUP" "USER"
created	string <date-time>
description	string
id	string
label	string
lastUpdated	string <date-time>
status	string (RoleStatus) Enum: "ACTIVE" "INACTIVE"
type	string (RoleType) Enum: "SUPER_ADMIN" "ORG_ADMIN" "APP_ADMIN" "USER_ADMIN" "HELP_DESK_ADMIN" "READ_ONLY_ADMIN" "MOBILE_ADMIN" "API_ACCESS_MANAGEMENT_ADMIN" "REPORT_ADMIN"

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"assignmentType": "GROUP",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"label": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"status": "ACTIVE",
"type": "SUPER_ADMIN"
}
]

assignRoleToUser

Assigns a role to a user.

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

disableNotifications

string

Request Body schema: application/json

type	string (RoleType) Enum: "SUPER_ADMIN" "ORG_ADMIN" "APP_ADMIN" "USER_ADMIN" "HELP_DESK_ADMIN" "READ_ONLY_ADMIN" "MOBILE_ADMIN" "API_ACCESS_MANAGEMENT_ADMIN" "REPORT_ADMIN"

Responses

Response Schema: application/json

	object
	object
assignmentType	string (RoleAssignmentType) Enum: "GROUP" "USER"
created	string <date-time>
description	string
id	string
label	string
lastUpdated	string <date-time>
status	string (RoleStatus) Enum: "ACTIVE" "INACTIVE"
type	string (RoleType) Enum: "SUPER_ADMIN" "ORG_ADMIN" "APP_ADMIN" "USER_ADMIN" "HELP_DESK_ADMIN" "READ_ONLY_ADMIN" "MOBILE_ADMIN" "API_ACCESS_MANAGEMENT_ADMIN" "REPORT_ADMIN"

Request samples

Content type

application/json

{"type": "SUPER_ADMIN"
}

Response samples

201

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"assignmentType": "GROUP",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"label": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"status": "ACTIVE",
"type": "SUPER_ADMIN"
}

removeRoleFromUser

Unassigns a role from a user.

Authorizations:

api_token

path Parameters

roleId required	string
userId required	string

Responses

getUserRole

Gets role that is assigned to user.

Authorizations:

api_token

path Parameters

roleId required	string
userId required	string

Responses

Response Schema: application/json

	object
	object
assignmentType	string (RoleAssignmentType) Enum: "GROUP" "USER"
created	string <date-time>
description	string
id	string
label	string
lastUpdated	string <date-time>
status	string (RoleStatus) Enum: "ACTIVE" "INACTIVE"
type	string (RoleType) Enum: "SUPER_ADMIN" "ORG_ADMIN" "APP_ADMIN" "USER_ADMIN" "HELP_DESK_ADMIN" "READ_ONLY_ADMIN" "MOBILE_ADMIN" "API_ACCESS_MANAGEMENT_ADMIN" "REPORT_ADMIN"

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"assignmentType": "GROUP",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"label": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"status": "ACTIVE",
"type": "SUPER_ADMIN"
}

listApplicationTargetsForApplicationAdministratorRoleForUser

Lists all App targets for an APP_ADMIN Role assigned to a User. This methods return list may include full Applications or Instances. The response for an instance will have an ID value, while Application will not have an ID.

Authorizations:

api_token

path Parameters

roleId required	string
userId required	string

query Parameters

after	string
limit	integer <int32> Default: 20

Responses

Response Schema: application/json

Array ()

	object
category	string
description	string
displayName	string
features	Array of strings
id	string
lastUpdated	string <date-time>
name	string
signOnModes	Array of strings
status	string (CatalogApplicationStatus) Enum: "ACTIVE" "INACTIVE"
verificationStatus	string
website	string

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"displayName": "string",
"description": "string",
"status": "ACTIVE",
"lastUpdated": "2019-08-24T14:15:22Z",
"category": "string",
"verificationStatus": "string",
"website": "string",
"signOnModes": ["string"
],
"features": ["string"
],
"_links": {"property1": { },
"property2": { }
}
}
]

addAllAppsAsTargetToRole

Success

Authorizations:

api_token

path Parameters

roleId required	string
userId required	string

Responses

addApplicationTargetToAdminRoleForUser

Success

Authorizations:

api_token

path Parameters

appName required	string
roleId required	string
userId required	string

Responses

removeApplicationTargetFromApplicationAdministratorRoleForUser

Success

Authorizations:

api_token

path Parameters

appName required	string
roleId required	string
userId required	string

Responses

Add App Instance Target to App Administrator Role given to a User

Authorizations:

api_token

path Parameters

applicationId required	string
appName required	string
roleId required	string
userId required	string

Responses

Remove App Instance Target to App Administrator Role given to a User

Authorizations:

api_token

path Parameters

applicationId required	string
appName required	string
roleId required	string
userId required	string

Responses

listGroupTargetsForRole

Success

Authorizations:

api_token

path Parameters

roleId required	string
userId required	string

query Parameters

after	string
limit	integer <int32> Default: 20

Responses

Response Schema: application/json

Array ()

	object
	object
created	string <date-time>
id	string
lastMembershipUpdated	string <date-time>
lastUpdated	string <date-time>
objectClass	Array of strings
	object (GroupProfile)
type	string (GroupType) Enum: "OKTA_GROUP" "APP_GROUP" "BUILT_IN"

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"id": "string",
"lastMembershipUpdated": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z",
"objectClass": ["string"
],
"profile": {"description": "string",
"name": "string"
},
"type": "OKTA_GROUP"
}
]

addGroupTargetToRole

Success

Authorizations:

api_token

path Parameters

groupId required	string
roleId required	string
userId required	string

Responses

removeGroupTargetFromRole

Success

Authorizations:

api_token

path Parameters

groupId required	string
roleId required	string
userId required	string

Responses

clearUserSessions

Removes all active identity provider sessions. This forces the user to authenticate on the next operation. Optionally revokes OpenID Connect and OAuth refresh and access tokens issued to the user.

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

oauthTokens

boolean

Default: false

Revoke issued OpenID Connect and OAuth refresh and access tokens

Responses

UserFactor

listFactors

Enumerates all the enrolled factors for the specified user

Authorizations:

api_token

path Parameters

userId

required

string

Responses

Response Schema: application/json

Array ()

object (CallUserFactorProfile)

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"factorType": "call",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"provider": "OKTA",
"status": "PENDING_ACTIVATION",
"verify": {"activationToken": "string",
"answer": "string",
"attestation": "string",
"clientData": "string",
"nextPassCode": "string",
"passCode": "string",
"registrationData": "string",
"stateToken": "string"
}
}
]

Enroll Factor

Enrolls a user with a supported factor.

Authorizations:

api_token

path Parameters

userId

required

string

query Parameters

activate	boolean Default: false
templateId	string id of SMS template (only for SMS factor)
tokenLifetimeSeconds	integer <int32> Default: 300
updatePhone	boolean Default: false

Request Body schema: application/json

Factor

object (CallUserFactorProfile)

Responses

Response Schema: application/json

object (CallUserFactorProfile)

Request samples

Content type

application/json

Example

{"profile": {"phoneExtension": "string",
"phoneNumber": "string"
},
"factorType": "call"
}

Response samples

200

Content type

application/json

Example

{"profile": {"phoneExtension": "string",
"phoneNumber": "string"
},
"factorType": "call"
}

listSupportedFactors

Enumerates all the supported factors that can be enrolled for the specified user

Authorizations:

api_token

path Parameters

userId

required

string

Responses

Response Schema: application/json

Array ()

object (CallUserFactorProfile)

Response samples

200

Content type

application/json

[{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"factorType": "call",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"provider": "OKTA",
"status": "PENDING_ACTIVATION",
"verify": {"activationToken": "string",
"answer": "string",
"attestation": "string",
"clientData": "string",
"nextPassCode": "string",
"passCode": "string",
"registrationData": "string",
"stateToken": "string"
}
}
]

listSupportedSecurityQuestions

Enumerates all available security questions for a user's question factor

Authorizations:

api_token

path Parameters

userId

required

string

Responses

Response Schema: application/json

Array ()

answer	string
question	string
questionText	string

Response samples

200

Content type

application/json

[{"answer": "string",
"question": "string",
"questionText": "string"
}
]

getFactor

Fetches a factor for the specified user

Authorizations:

api_token

path Parameters

factorId required	string
userId required	string

Responses

Response Schema: application/json

object (CallUserFactorProfile)

Response samples

200

Content type

application/json

Example

{"profile": {"phoneExtension": "string",
"phoneNumber": "string"
},
"factorType": "call"
}

deleteFactor

Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor.

Authorizations:

api_token

path Parameters

factorId required	string
userId required	string

Responses

Activate Factor

The sms and token:software:totp factor types require activation to complete the enrollment process.

Authorizations:

api_token

path Parameters

factorId required	string
userId required	string

Request Body schema: application/json

attestation	string
clientData	string
passCode	string
registrationData	string
stateToken	string

Responses

Response Schema: application/json

object (CallUserFactorProfile)

Request samples

Content type

application/json

{"attestation": "string",
"clientData": "string",
"passCode": "string",
"registrationData": "string",
"stateToken": "string"
}

Response samples

200

Content type

application/json

Example

{"profile": {"phoneExtension": "string",
"phoneNumber": "string"
},
"factorType": "call"
}

getFactorTransactionStatus

Polls factors verification transaction for status.

Authorizations:

api_token

path Parameters

factorId required	string
transactionId required	string
userId required	string

Responses

Response Schema: application/json

	object
	object
expiresAt	string <date-time>
factorResult	string Enum: "SUCCESS" "EXPIRED" "CHALLENGE" "WAITING" "FAILED" "REJECTED" "TIMEOUT" "TIME_WINDOW_EXCEEDED" "PASSCODE_REPLAYED" "ERROR"
factorResultMessage	string

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"expiresAt": "2019-08-24T14:15:22Z",
"factorResult": "SUCCESS",
"factorResultMessage": "string"
}

Verify MFA Factor

Verifies an OTP for a token or token:hardware factor

Authorizations:

api_token

path Parameters

factorId required	string
userId required	string

query Parameters

templateId	string
tokenLifetimeSeconds	integer <int32> Default: 300

header Parameters

Accept-Language	string
User-Agent	string
X-Forwarded-For	string

Request Body schema: application/json

activationToken	string
answer	string
attestation	string
clientData	string
nextPassCode	string
passCode	string
registrationData	string
stateToken	string

Responses

Response Schema: application/json

	object
	object
expiresAt	string <date-time>
factorResult	string Enum: "SUCCESS" "EXPIRED" "CHALLENGE" "WAITING" "FAILED" "REJECTED" "TIMEOUT" "TIME_WINDOW_EXCEEDED" "PASSCODE_REPLAYED" "ERROR"
factorResultMessage	string

Request samples

Content type

application/json

{"activationToken": "string",
"answer": "string",
"attestation": "string",
"clientData": "string",
"nextPassCode": "string",
"passCode": "string",
"registrationData": "string",
"stateToken": "string"
}

Response samples

200

Content type

application/json

{"_embedded": {"property1": { },
"property2": { }
},
"_links": {"property1": { },
"property2": { }
},
"expiresAt": "2019-08-24T14:15:22Z",
"factorResult": "SUCCESS",
"factorResultMessage": "string"
}

UserSchema

Fetches the Schema for an App User

Authorizations:

api_token

path Parameters

appInstanceId

required

string

Responses

Response Schema: application/json

	object
$schema	string
created	string
	object (UserSchemaDefinitions)
id	string
lastUpdated	string
name	string
	object (UserSchemaProperties)
title	string
type	string

Response samples

200

Content type

application/json

{"id": "string",
"$schema": "string",
"name": "string",
"title": "string",
"lastUpdated": "string",
"created": "string",
"definitions": {"base": {"id": "string",
"type": "string",
"properties": {"login": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"firstName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"lastName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"middleName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"honorificPrefix": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"honorificSuffix": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"email": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"title": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"displayName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"nickName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"profileUrl": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"secondEmail": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"mobilePhone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"primaryPhone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"streetAddress": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"city": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"state": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"zipCode": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"countryCode": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"postalAddress": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"preferredLanguage": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"locale": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"timezone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"userType": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"employeeNumber": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"costCenter": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"organization": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"division": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"department": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"managerId": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"manager": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
}
},
"required": ["string"
]
},
"custom": {"id": "string",
"type": "string",
"properties": {"property1": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"property2": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
}
},
"required": ["string"
]
}
},
"type": "string",
"properties": {"profile": {"allOf": [{"$ref": "string"
}
]
}
},
"_links": {"property1": { },
"property2": { }
}
}

Partial updates on the User Profile properties of the Application User Schema.

Authorizations:

api_token

path Parameters

appInstanceId

required

string

Request Body schema: application/json

	object (UserSchemaDefinitions)
	object (UserSchemaProperties)
title	string

Responses

Response Schema: application/json

	object
$schema	string
created	string
	object (UserSchemaDefinitions)
id	string
lastUpdated	string
name	string
	object (UserSchemaProperties)
title	string
type	string

Request samples

Content type

application/json

{"title": "string",
"definitions": {"base": {"id": "string",
"type": "string",
"properties": {"login": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"firstName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"lastName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"middleName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"honorificPrefix": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"honorificSuffix": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"email": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"title": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"displayName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"nickName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"profileUrl": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"secondEmail": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"mobilePhone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"primaryPhone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"streetAddress": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"city": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"state": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"zipCode": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"countryCode": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"postalAddress": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"preferredLanguage": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"locale": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"timezone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"userType": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"employeeNumber": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"costCenter": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"organization": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"division": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"department": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"managerId": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"manager": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
}
},
"required": ["string"
]
},
"custom": {"id": "string",
"type": "string",
"properties": {"property1": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"property2": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
}
},
"required": ["string"
]
}
},
"properties": {"profile": {"allOf": [{"$ref": "string"
}
]
}
}
}

Response samples

200

Content type

application/json

{"id": "string",
"$schema": "string",
"name": "string",
"title": "string",
"lastUpdated": "string",
"created": "string",
"definitions": {"base": {"id": "string",
"type": "string",
"properties": {"login": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"firstName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"lastName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"middleName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"honorificPrefix": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"honorificSuffix": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"email": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"title": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"displayName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"nickName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"profileUrl": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"secondEmail": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"mobilePhone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"primaryPhone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"streetAddress": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"city": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"state": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"zipCode": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"countryCode": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"postalAddress": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"preferredLanguage": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"locale": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"timezone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"userType": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"employeeNumber": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"costCenter": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"organization": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"division": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"department": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"managerId": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"manager": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
}
},
"required": ["string"
]
},
"custom": {"id": "string",
"type": "string",
"properties": {"property1": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"property2": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
}
},
"required": ["string"
]
}
},
"type": "string",
"properties": {"profile": {"allOf": [{"$ref": "string"
}
]
}
},
"_links": {"property1": { },
"property2": { }
}
}

Fetches the schema for a Schema Id.

Authorizations:

api_token

path Parameters

schemaId

required

string

Responses

Response Schema: application/json

	object
$schema	string
created	string
	object (UserSchemaDefinitions)
id	string
lastUpdated	string
name	string
	object (UserSchemaProperties)
title	string
type	string

Response samples

200

Content type

application/json

{"id": "string",
"$schema": "string",
"name": "string",
"title": "string",
"lastUpdated": "string",
"created": "string",
"definitions": {"base": {"id": "string",
"type": "string",
"properties": {"login": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"firstName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"lastName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"middleName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"honorificPrefix": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"honorificSuffix": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"email": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"title": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"displayName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"nickName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"profileUrl": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"secondEmail": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"mobilePhone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"primaryPhone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"streetAddress": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"city": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"state": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"zipCode": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"countryCode": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"postalAddress": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"preferredLanguage": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"locale": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"timezone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"userType": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"employeeNumber": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"costCenter": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"organization": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"division": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"department": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"managerId": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"manager": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
}
},
"required": ["string"
]
},
"custom": {"id": "string",
"type": "string",
"properties": {"property1": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"property2": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
}
},
"required": ["string"
]
}
},
"type": "string",
"properties": {"profile": {"allOf": [{"$ref": "string"
}
]
}
},
"_links": {"property1": { },
"property2": { }
}
}

updateUserProfile

Partial updates on the User Profile properties of the user schema.

Authorizations:

api_token

path Parameters

schemaId

required

string

Request Body schema: application/json

	object (UserSchemaDefinitions)
	object (UserSchemaProperties)
title	string

Responses

Response Schema: application/json

	object
$schema	string
created	string
	object (UserSchemaDefinitions)
id	string
lastUpdated	string
name	string
	object (UserSchemaProperties)
title	string
type	string

Request samples

Content type

application/json

{"title": "string",
"definitions": {"base": {"id": "string",
"type": "string",
"properties": {"login": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"firstName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"lastName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"middleName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"honorificPrefix": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"honorificSuffix": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"email": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"title": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"displayName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"nickName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"profileUrl": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"secondEmail": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"mobilePhone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"primaryPhone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"streetAddress": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"city": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"state": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"zipCode": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"countryCode": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"postalAddress": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"preferredLanguage": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"locale": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"timezone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"userType": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"employeeNumber": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"costCenter": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"organization": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"division": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"department": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"managerId": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"manager": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
}
},
"required": ["string"
]
},
"custom": {"id": "string",
"type": "string",
"properties": {"property1": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"property2": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
}
},
"required": ["string"
]
}
},
"properties": {"profile": {"allOf": [{"$ref": "string"
}
]
}
}
}

Response samples

200

Content type

application/json

{"id": "string",
"$schema": "string",
"name": "string",
"title": "string",
"lastUpdated": "string",
"created": "string",
"definitions": {"base": {"id": "string",
"type": "string",
"properties": {"login": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"firstName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"lastName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"middleName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"honorificPrefix": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"honorificSuffix": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"email": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"title": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"displayName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"nickName": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"profileUrl": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"secondEmail": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"mobilePhone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"primaryPhone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"streetAddress": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"city": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"state": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"zipCode": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"countryCode": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"postalAddress": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"preferredLanguage": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"locale": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"timezone": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"userType": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"employeeNumber": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"costCenter": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"organization": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"division": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"department": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"managerId": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"manager": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
}
},
"required": ["string"
]
},
"custom": {"id": "string",
"type": "string",
"properties": {"property1": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
},
"property2": {"title": "string",
"type": "string",
"required": true,
"mutability": "string",
"scope": "SELF",
"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"minLength": 0,
"maxLength": 0,
"description": "string",
"permissions": [{"principal": "string",
"action": "string"
}
],
"master": {"type": "PROFILE_MASTER",
"priority": [{"type": "string",
"value": "string"
}
]
},
"union": "DISABLE",
"items": {"enum": ["string"
],
"oneOf": [{"const": "string",
"title": "string"
}
],
"type": "string"
},
"pattern": "string",
"unique": "string",
"externalName": "string",
"externalNamespace": "string"
}
},
"required": ["string"
]
}
},
"type": "string",
"properties": {"profile": {"allOf": [{"$ref": "string"
}
]
}
},
"_links": {"property1": { },
"property2": { }
}
}

UserType

listUserTypes

Fetches all User Types in your org

Authorizations:

api_token

Responses

Response Schema: application/json

Array ()

	object
created	string <date-time>
createdBy	string
default	boolean
description	string
displayName	string
id	string
lastUpdated	string <date-time>
lastUpdatedBy	string
name	string

Response samples

200

Content type

application/json

[{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string"
}
]

createUserType

Creates a new User Type. A default User Type is automatically created along with your org, and you may add another 9 User Types for a maximum of 10.

Authorizations:

api_token

Request Body schema: application/json

description	string
displayName	string
id	string
name	string

Responses

Response Schema: application/json

	object
created	string <date-time>
createdBy	string
default	boolean
description	string
displayName	string
id	string
lastUpdated	string <date-time>
lastUpdatedBy	string
name	string

Request samples

Content type

application/json

{"description": "string",
"displayName": "string",
"id": "string",
"name": "string"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string"
}

getUserType

Fetches a User Type by ID. The special identifier default may be used to fetch the default User Type.

Authorizations:

api_token

path Parameters

typeId

required

string

Responses

Response Schema: application/json

	object
created	string <date-time>
createdBy	string
default	boolean
description	string
displayName	string
id	string
lastUpdated	string <date-time>
lastUpdatedBy	string
name	string

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string"
}

replaceUserType

Replace an existing User Type

Authorizations:

api_token

path Parameters

typeId

required

string

Request Body schema: application/json

description	string
displayName	string
id	string
name	string

Responses

Response Schema: application/json

	object
created	string <date-time>
createdBy	string
default	boolean
description	string
displayName	string
id	string
lastUpdated	string <date-time>
lastUpdatedBy	string
name	string

Request samples

Content type

application/json

{"description": "string",
"displayName": "string",
"id": "string",
"name": "string"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string"
}

updateUserType

Updates an existing User Type

Authorizations:

api_token

path Parameters

typeId

required

string

Request Body schema: application/json

description	string
displayName	string
id	string
name	string

Responses

Response Schema: application/json

	object
created	string <date-time>
createdBy	string
default	boolean
description	string
displayName	string
id	string
lastUpdated	string <date-time>
lastUpdatedBy	string
name	string

Request samples

Content type

application/json

{"description": "string",
"displayName": "string",
"id": "string",
"name": "string"
}

Response samples

200

Content type

application/json

{"_links": {"property1": { },
"property2": { }
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"default": true,
"description": "string",
"displayName": "string",
"id": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "string",
"name": "string"
}

deleteUserType

Deletes a User Type permanently. This operation is not permitted for the default type, nor for any User Type that has existing users

Authorizations:

api_token

path Parameters

typeId

required

string

Okta API (2.7.0)

Authentication

api_token

oauth2

Application

List Applications

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Add Application

Authorizations:

query Parameters

header Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Get Application

Authorizations:

path Parameters

query Parameters

Responses

Response Schema: application/json

Response samples

Update Application

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Delete Application

Authorizations:

path Parameters

Responses

List Certificate Signing Requests for Application

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Generate Certificate Signing Request for Application

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Get Certificate Signing Request

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Revoke Certificate Signing Request

Authorizations:

path Parameters

Responses

Publish Certificate Signing Request

Authorizations:

path Parameters

Request Body schema: application/octet-streamapplication/octet-streamapplication/x-x509-ca-certapplication/pkix-certapplication/x-pem-file

Responses

Response Schema: application/json

Response samples

List Key Credentials for Application

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

generateApplicationKey

Authorizations:

path Parameters

query Parameters

Request Body schema:
application/octet-stream
application/octet-stream
application/x-x509-ca-cert
application/pkix-cert
application/x-pem-file